3.6. Triple Play DHCP Command Reference

3.6.1. Command Hierarchies

Note:

  1. The command trees in this section are limited to those commands specific to Triple Play services. For the full command trees for a specific service type, refer to the 7450 ESS, 7750 SR, 7950 XRS, and VSR Layer 2 Services and EVPN Guide: VLL, VPLS, PBB, and EVPN and the 7450 ESS, 7750 SR, 7950 XRS, and VSR Layer 3 Services Guide: IES and VPRN.
  1. DHCP Filter Commands
    1. DHCP Filter Commands
    2. DHCP6 Filter Commands
  2. Router Local DHCP Server Commands
  3. Router Local DHCP6 Server Commands
  4. Subscriber Management Commands
    1. IPoE Commands
    2. PPP Commands
    3. MSAP Policy Commands
  5. IES and VPRN Service DHCP Commands
    1. VPRN Local DHCP Server Commands
    2. VPLS DHCP Commands
  6. System DHCP Commands
  7. Show Commands
  8. Tools Commands
  9. Clear Commands
  10. Debug Commands

3.6.1.1. DHCP Filter Commands

3.6.1.1.1. DHCP Filter Commands

config
— filter
— [no] dhcp-filter filter-id [create]
— default-action {bypass-host-creation | drop}
— no default-action
— description description-string
— no description
— entry entry-id [create]
— no entry entry-id
— action bypass-host-creation
— action drop
— no action
— option dhcp-option-number {present | absent}
— option dhcp-option-number match hex hex-string [exact] [invert-match]
— option dhcp-option-number match string ascii-string [exact] [invert-match]
— no option

3.6.1.1.2. DHCP6 Filter Commands

config
— filter
— [no] dhcp6-filter filter-id [create]
— default-action bypass-host-creation [na] [pd]
— default-action drop
— no default-action
— description description-string
— no description
— entry entry-id [create]
— no entry entry-id
— action bypass-host-creation [na] [pd]
— action drop
— no action
— option dhcp6-option-number {present | absent}
— option dhcp6-option-number match hex hex-string [exact] [invert-match]
— option dhcp6-option-number match string ascii-string [exact] [invert-match]
— no option

3.6.1.2. Router Local DHCP Server Commands

config
— router
— dhcp
— local-dhcp-server server-name [create]
— no local-dhcp-server server-name
— description description-string
— no description
— failover
— [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
— startup-wait-time [min minutes] [sec seconds] [hrs hours]
— no startup-wait-time [min minutes] [sec seconds]
— [no] force-renews
— lease-hold-time [days days] [hrs hours] [min minutes] [sec seconds]
— no lease-hold-time
— [no] lease-hold-time-for
— [no] internal-lease-ipsec
— [no] solicited-release
— pool pool-name [create]
— no pool pool-name
— description description-string
— no description
— failover
— [no] ignore-mclt-on-takeover
— maximum-client-lead-time [maximum-client-lead-time]
— no maximum-client-lead-time
— partner-down-delay [partner-down-delay]
— no partner-down-delay
— peer ip-address tag sync-tag
— no peer
— [no] shutdown
— [no] startup-wait-time [min minutes] [sec seconds] [hrs hours]
— max-lease-time [max-lease-time]
— no max-lease-time
— min-lease-time [min-lease-time]
— no min-lease-time
— minimum-free minimum-free [percent] [event-when-depleted]
— no minimum-free
— [no] nak-non-matching-subnet
— offer-time [min minutes] [sec seconds]
— no offer-time
— options
— custom-option option-number address [ip-address]
— 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]
— no default-router
— lease-rebind-time [lease-rebind-time]
— no lease-rebind-time
— lease-renew-time [lease-renew-time]
— no lease-renew-time
— lease-time [lease-time]
— no lease-time
— netbios-name-server ip-address [ip-address]
— no netbios-name-server
— netbios-node-type netbios-node-type
— no netbios-node-type
— subnet {ip-address/mask | ip-address netmask} [create]
— no subnet {ip-address/mask | ip-address netmask}
— address-range start-ip-address end-ip-address [failover {local | remote| access-driven}]
— no address-range start-ip-address end-ip-address
— [no] drain
— [no] exclude-addresses start-ip-address [end-ip-address]
— maximum-declined maximum-declined
— no maximum-declined
— minimum-free minimum-free [percent] [event-when-depleted]
— no minimum-free
— options
— custom-option option-number address [ip-address]
— 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]
— no default-router
— subnet-mask ip-address
— no subnet-mask
— [no] shutdown
— use-gi-address [scope scope]
— no use-gi-address
— use-pool-from-client delimiter delimiter
— use-pool-from-client
— no use-pool-from-client
— user-db local-user-db-name
— no user-db
— user-ident user-ident
— no user-ident

3.6.1.3. Router Local DHCP6 Server Commands

config
— router
— dhcp6
— local-dhcp-server server-name [create] [auto-provisioned]
— no local-dhcp-server server-name
— [no] allow-lease-query
— description description-string
— no description
— defaults
— options
— custom-option option-number address [ipv6-address]
— custom-option option-number domain domain-string
— custom-option option-number hex hex-string
— custom-option option-number string ascii-string
— no custom-option option-number
— dns-server ipv6-address [ipv6-address]
— no dns-server
— domain-name domain-name
— no domain-name
— preferred-lifetime [days days] [hrs hours] [min minutes] [sec seconds]
— no preferred-lifetime
— rebind-timer [rebind-timer]
— no rebind-timer
— renew-timer [renew-timer]
— no renew-timer
— valid-lifetime [valid-lifetime]
— no valid-lifetime
— failover
— [no] ignore-mclt-on-takeover
— maximum-client-lead-time [hrs hours] [min minutes] [sec seconds]
— no maximum-client-lead-time
— partner-down-delay [partner-down-delay]
— no partner-down-delay
— peer ip-address tag sync-tag
— no peer
— [no] shutdown
— [no] startup-wait-time [min minutes] [sec seconds] [hrs hours]
— [no] ignore-rapid-commit
— [no] interface-id-mapping
— lease-hold-time [lease-hold-time]
— no lease-hold-time
— [no] lease-hold-time-for
— [no] internal-lease-ipsec
— [no] solicited-release
— pool pool-name [create]
— no pool pool-name
— delegated-prefix-length bits [minimum prefix-length] [maximum prefix-length]
— no delegated-prefix-length
— description description-string
— no description
— [no] exclude-prefix ipv6-prefix/prefix-length
— failover
— [no] ignore-mclt-on-takeover
— maximum-client-lead-time [maximum-client-lead-time]
— no maximum-client-lead-time
— partner-down-delay [partner-down-delay]
— no partner-down-delay
— peer ip-address tag sync-tag
— no peer
— [no] shutdown
— [no] startup-wait-time [min minutes] [sec seconds] [hrs hours]
— options
— custom-option option-number address [ipv6-address]
— custom-option option-number domain domain-string
— custom-option option-number hex hex-string
— custom-option option-number string ascii-string
— no custom-option option-number
— dns-server ipv6-address [ipv6-address]
— no dns-server
— domain-name domain-name
— no domain-name
— prefix ipv6-addr/prefix-len [failover {local | remote | access-driven}] [pd] [wan-host] [create]
— no prefix ipv6-addr/prefix-len
— [no] drain
— options
— custom-option option-number address ipv6-address [ipv6-address]
— custom-option option-number domain domain-string
— custom-option option-number hex hex-string
— custom-option option-number string ascii-string
— no custom-option option-number
— dns-server ipv6-address [ipv6-address]
— no dns-server
— domain-name domain-name
— no domain-name
— preferred-lifetime [days days] [hrs hours] [min minutes] [sec seconds]
— no preferred-lifetime
— rebind-timer [days days] [hrs hours] [min minutes] [sec seconds]
— no rebind-timer
— renew-timer [days days] [hrs hours] [min minutes] [sec seconds]
— no renew-timer
— thresholds
— [no] minimum-free prefix-length [prefix-length]
— [no] depleted-event
— minimum percent [percent] [number [number]]
— no minimum
— valid-lifetime [days days] [hrs hours] [min minutes] [sec seconds]
— no valid-lifetime
— thresholds
— [no] minimum-free prefix-length [prefix-length]
— [no] depleted-event
— minimum percent [percent]
— no minimum
— server-id duid-en hex hex-string
— server-id duid-en string ascii-string
— server-id duid-ll
— no server-id
— [no] shutdown
— use-link-address [scope scope]
— no use-link-address
— user-db local-user-db-name
— no user-db
— user-ident user-ident
— no user-ident

3.6.1.4. Subscriber Management Commands

  1. IPoE Commands
  2. PPP Commands

3.6.1.4.1. IPoE Commands

config
— subscriber-mgmt
— local-user-db local-user-db-name [create]
— no local-user-db local-user-db-name
— description description-string
— no description
— ipoe
— host host-name [create]
— no host host-name
— acct-policy acct-policy-name [duplicate acct-policy-name]
— no acct-policy
— 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]
— no address
— auth-domain-name domain-name
— no auth-domain-name
— auth-policy policy-name
— no auth-policy
— diameter-application-policy policy-name
— no diameter-application-policy
— diameter-auth-policy name
— no diameter-auth-policy
— gi-address ip-address
— no gi-address
— host-identification
— circuit-id string ascii-string
— circuit-id hex hex-string
— no circuit-id
— derived-id derived-id-string
— no derived-id
— encap-tag-range start-tag start-tag end-tag end-tag
— no encap-tag-range
— ip-prefix ip-prefix/ip-prefix-length
— no ip-prefix
— mac ieee-address
— no mac
— option60 hex hex-string
— option60 string ascii-string
— no option60
— remote-id hex hex-string
— remote-id string ascii-string
— no remote-id
— sap-id sap-id
— no sap-id
— service-id service-id
— no service-id
— string string
— no string
— system-id system-id
— no system-id
— identification-strings option-number [create]
— no identification-strings
— ancp-string ancp-string
— no ancp-string
— app-profile-string app-profile-string
— no app-profile-string
— category-map-name category-map-name
— no category-map-name
— inter-dest-id intermediate-destination-id
— no inter-dest-id
— sla-profile-string sla-profile-string
— no sla-profile-string
— spi-sharing-group-id group-id
— no spi-sharing-group-id
— sub-profile-stringsub-profile-string
— no sub-profile-string
— subscriber-id sub-ident-string
— no subscriber-id
— interface ip-int-name service-id service-id
— ipv6-address ipv6-address
— no ipv6-address
— ipv6-delegated-prefix ipv6-prefix/prefix-length
— no ipv6-delegated-prefix
— ipv6-delegated-prefix-length bits
— no ipv6-delegated-prefix-length
— ipv6-delegated-prefix-pool pool-name
— no ipv6-delegated-prefix-pool
— [no] ipv6-lease-times
— preferred-lifetime [preferred-lifetime]
— preferred-lifetime infinite
— no preferred-lifetime
— rebind-timer [rebind-timer]
— no rebind-timer
— renew-timer [renew-timer]
— no renew-timer
— valid-lifetime [valid-lifetime]
— valid-lifetime infinite
— no valid-lifetime
— ipv6-slaac-prefix ipv6-prefix/prefix-length
— no ipv6-slaac-prefix
— ipv6-slaac-prefix-pool pool
— no ipv6-slaac-prefix-pool
— ipv6-wan-address-pool pool-name
— no ipv6-wan-address-pool
— link-address ipv6-address
— no link-address
— match-radius-proxy-cache
— fail-action {continue | drop}
— no fail-action
— mac-format mac-format
— no mac-format
— match {circuit-id | mac | remote-id}
— match option [number] [option6 [number]]
— match option6 [number]
— no match
— server [service service-id] name server-name
— no server
— mld-parameters
— import policy-name
— no import
— msap-defaults
— group-interface ip-int-name [prefix {port-id}]
— group-interface ip-int-name [suffix {port-id}]
— no group-interface
— msap-policy msap-policy-name
— no msap-policy
— service service-id
— no service
— options
— custom-option option-number address [ip-address]
— 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]
— no default-router
— dns-server ip-address [ip-address]
— no dns-server
— domain-name domain-name
— no domain-name
— lease-rebind-time [lease-rebind-time]
— no lease-rebind-time
— lease-renew-time [lease-renew-time]
— no lease-renew-time
— lease-time [lease-time]
— no lease-time
— netbios-name-server ip-address [ip-address]
— no netbios-name-server
— netbios-node-type netbios-node-type
— no netbios-node-type
— subnet-mask ip-address
— no subnet-mask
— options6
— dns-server ipv6-address [ipv6-address]
— no dns-server
— retail-service-id service-id
— no retail-service-id
— rip-policy policy-name
— no rip-policy
— router-advertisement-policy policy
— no router-advertisement-policy
— server ip-address
— no server
— server6 ipv6-address
— no server6
— [no] shutdown
— to-client-options
— ipv4
— option option-number address [ip-address]
— option option-number hex hex-string
— option option-number string ascii-string
— no option option-number
— ipv6
— option option-number address [ip-address.]
— option option-number hex hex-string
— option option-number string ascii-string
— option option-number domain domain-name
— no option option-number
— [no] to-server-options
— ipv6
— option option-number address [ip-address]
— option option-number hex hex-string
— option option-number string ascii-string
— option option-number domain domain-name
— no option option-number
— wpp
— initial-app-profile app-profile-name
— no initial-app-profile
— initial-sla-profile sla-profile-name
— no initial-sla-profile
— initial-sub-profile sub-profile-name
— no initial-sub-profile
— [no] portal router router-instance name wpp-portal-name
— portal-group portal-group-name
— no portal-group
— [no] restore-disconnected
— 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 match-type-1 [match-type-2]
— no match-list

3.6.1.4.2. PPP Commands

config
— subscriber-mgmt
— local-user-db local-user-db-name [create]
— no local-user-db local-user-db-name
— description description-string
— no description
— ppp
— host host-name [create]
— no host host-name
— [no] access-loop-encapsulation
— encap-offset [type type]
— no encap-offset
— rate-down rate
— no rate-down
— access-loop-information
— circuit-id sap-id
— circuit-id string ASCII string
— no circuit-id
— remote-id mac
— remote-id string ASCII string
— no remote-id
— acct-policy acct-policy-name [duplicate acct-policy-name]
— no acct-policy
— 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]
— no address
— auth-policy policy-name
— no auth-policy
— diameter-application-policy policy-name
— no diameter-application-policy
— diameter-auth-policy name
— no diameter-auth-policy
— [no] force-ipv6cp
— host-identification
— circuit-id string ascii-string
— circuit-id hex hex-string
— no circuit-id
— derived-id derived id-string
— no derived-id
— encap-tag-range start-tag start-tag end-tag end-tag
— no encap-tag-range
— mac ieee-address
— no mac
— remote-id hex hex-string
— remote-id string ascii-string
— no remote-id
— sap-id sap-id
— no sap-id
— service-name service-name
— no service-name
— username user-name
— username user-name no-domain
— username user-name domain-only
— no username
— identification-strings option-number [create]
— no identification-strings
— ancp-string ancp-string
— no ancp-string
— app-profile-string app-profile-string
— no app-profile-string
— category-map-name category-map-name
— no category-map-name
— inter-dest-id intermediate-destination-id
— no inter-dest-id
— sla-profile-string sla-profile-string
— no sla-profile-string
— spi-sharing-group-id group-id
— no spi-sharing-group-id
— sub-profile-string sub-profile-string
— no sub-profile-string
— subscriber-id sub-ident-string
— no subscriber-id
— [no] ignore-df-bit
— interface ip-int-name service-id service-id
— no interface
— ipv6-address ipv6-address
— no ipv6-address
— ipv6-delegated-prefix ipv6-prefix/prefix-length
— no ipv6-delegated-prefix
— ipv6-delegated-prefix-length bits
— no ipv6-delegated-prefix-length
— ipv6-delegated-prefix-pool pool-name
— no ipv6-delegated-prefix-pool
— [no] ipv6-lease-times
— preferred-lifetime [preferred-lifetime]
— preferred-lifetime infinite
— no preferred-lifetime
— rebind-timer [rebind-time]
— no rebind-timer
— renew-timer [renew-timer]
— no renew-timer
— valid-lifetime [valid-lifetime]
— valid-lifetime infinite
— no valid-lifetime
— ipv6-slaac-prefix ipv6-prefix/prefix-length
— no ipv6-slaac-prefix
— ipv6-slaac-prefix-pool pool
— no ipv6-slaac-prefix-pool
— ipv6-wan-address-pool pool-name
— no ipv6-wan-address-pool
— l2tp
— group tunnel-group-name [service-id service-id]
— no group
— mld-parameters
— import policy-name
— no import
— msap-defaults
— group-interface ip-int-name [prefix {port-id}]
— group-interface ip-int-name [suffix {port-id}]
— no group-interface
— msap-policy msap-policy-name
— no msap-policy
— service service-id
— no service
— options
— custom-option option-number address [ip-address]
— custom-option option-number hex hex-string
— custom-option option-number string ascii-string
— no custom-option option-number
— dns-server address [ip-address]
— no dns-server
— netbios-name-server ip-address [ip-address]
— no netbios-name-server
— options6
— dns-server ipv6-address [ipv6-address]
— no dns-server
— padi-auth-policy policy-name
— no padi-auth-policy
— pado-delay deci-seconds
— no pado-delay
— password ignore
— password {chap password |pap password} [hash | hash2 | custom]
— no password
— pre-auth-policy policy-name
— no pre-auth-policy
— retail-service-id service-id
— no retail-service-id
— rip-policy policy-name
— no rip-policy
— router-advertisement-policy policy
— no router-advertisement-policy
— [no] shutdown
— steering-profile. steering-profile-name
— no steering-profile.
— to-client-options
— ipv6
— option option-number address [ip-address]
— option option-number hex hex-string
— option option-number string ascii-string
— option option-number domain domain-name
— no option option-number
— user-db name
— no user-db
— mask type ppp-match-type {[prefix-string prefix-string | prefix-length prefix-length] [suffix-string suffix-string | suffix-length suffix-length]}
— no mask type ppp-match-type
— match-list match-type-1 [match-type-2]
— no match-list

3.6.1.4.3. MSAP Policy Commands

config
— subscriber-mgmt
— msap-policy msap-policy-name [create]
— no msap-policy msap-policy-name
— vpls-only-sap-parameters
— dhcp
— lease-populate [nbr-of-leases
— no lease-populate
— [no] option
— action dhcp-action
— no action
— circuit-id
— circuit-id {ascii-tuple | vlan-ascii-tuple}
— circuit-id hex [0x0..0xFFFFFFFF...(64 hex nibbles)]
— no circuit-id
— remote-id
— remote-id hex [0x0..0xFFFFFFFF...(64 hex nibbles)]
— remote-id mac
— remote-id string string
— no remote-id
— [no] vendor-specific-option
— [no] client-mac-address
— [no] sap-id
— [no] service-id
— string text
— no string
— [no] system-id
— proxy-server
— emulated-server ip-address
— no emulated-server
— lease-time [days days] [hrs hours] [min minutes] [sec seconds] [override]
— no lease-time
— [no] shutdown
— [no] shutdown

3.6.1.5. IES and VPRN Service DHCP Commands

config
— service
— ies service-id [customer customer-id] [create] [vpn vpn-id] [name name]
— no ies service-id
— interface ip-int-name [create]
— interface ip-int-name [create] tunnel
— no interface ip-int-name
— dhcp
— description description-string
— no description
— gi-address ip-address [src-ip-addr]
— no gi-address
— lease-populate nbr-of-leases
— no lease-populate
— [no] option
— 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
— [no] client-mac-address
— [no] pool-name
— [no] sap-id
— [no] service-id
— string text
— no string
— [no] system-id
— proxy-server
— emulated-server ip-address
— no emulated-server
— lease-time [days days] [hrs hours] [min minutes] [sec seconds] [override]
— no lease-time
— [no] shutdown
— python-policy name
— no python-policy
— [no] relay-plain-bootp
— relay-proxy [release-update-src-ip] [siaddr-override ip-address]
— no relay-proxy
— server server1 [server2]
— no server
— [no] shutdown
— [no] trusted
— [no] use-arp
— [no] ipv6
— address ipv6-address/prefix-length [eui-64]
— no address ipv6-address/prefix-length
— [no] dhcp6-relay
— description description-string
— no description
— dhcp6-relay [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]
— no lease-populate
— link-address ipv6-address
— no link-address
— [no] neighbor-resolution
— [no] option
— interface-id
— interface-id [ascii-tuple]
— interface-id ifindex
— interface-id sap-id
— interface-id string
— no interface-id
— [no] remote-id
— python-policy policy-name
— no python-policy
— server ipv6z-address [ipv6z-address]
— no server [ipv6z-address]
— [no] shutdown
— source-address ipv6-address
— no source-address
— user-db local-user-db-name
— no user-db
— [no] dhcp6-server
— max-nbr-of-leases max-nbr-of-leases
— no max-nbr-of-leases
— [no] prefix-delegation
— [no] prefix ipv6-address/prefix-length
— duid duid [iaid iaid]
— no duid
— preferred-lifetime seconds
— preferred-lifetime infinite
— no preferred-lifetime
— valid-lifetime seconds
— valid-lifetime infinite
— no valid-lifetime
— [no] shutdown
— local-dhcp-server local-server-name
— no local-dhcp-server
— [no] subscriber-interface ip-int-name [create]
— dhcp
— client-applications {[dhcp] [ppp]}
— no client-applications
— gi-address ip-address [src-ip-addr]
— no gi-address
— lease-populate [nbr-of-leases]
— lease-populate [nbr-of-leases] l2-header [mac ieee-address]
— no lease-populate
— [no] option
— [no] vendor-specific-option
— [no] client-mac-address
— [no] pool-name
— [no] sap-id
— [no] service-id
— string text
— no string
— [no] system-id
— proxy-server
— emulated-server ip-address
— no emulated-server
— lease-time [days days] [hrs hours] [min minutes] [sec seconds] [override]
— no lease-time
— [no] shutdown
— python-policy python-name
— no python-policy
— relay-proxy [release-update-src-ip] [siaddr-override ip-address]
— no relay-proxy
— [no] virtual-subnet
— local-address-assignment
— client-application [ppp-v4] [ipoe-v4]
— no client-application
— default-pool pool-name [secondary pool-name]
— no default-pool
— server server-name
— no server
— [no] shutdown
— [no] group-interface ip-int-name [create]
— dhcp
— client-applications {[dhcp] [ppp]}
— no client-applications
— description description-string
— no description
— [no] filter filter-id
— gi-address ip-address [src-ip-addr]
— no gi-address ip-address
— lease-populate [nbr-of-leases]
— lease-populate [nbr-of-leases] l2-header [mac ieee-address]
— no lease-populate
— [no] match-circuit-id
— [no] option
— 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
— [no] client-mac-address
— [no] pool-name
— [no] sap-id
— [no] service-id
— string text
— no string
— [no] system-id
— proxy-server
— emulated-server ip-address
— no emulated-server
— lease-time [days days] [hrs hours] [min minutes] [sec seconds] [override]
— no lease-time
— [no] shutdown
— python-policy name
— no python-policy
— relay-proxy [release-update-src-ip] [siaddr-override ip-address]
— no relay-proxy
— server server1 [server2]
— no server
— [no] shutdown
— [no] trusted
— user-db local-user-db-name
— no user-db
— ipv6
— [no] dhcp6
— filter filter-id
— no filter
— [no] option
— interface-id [ascii-tuple]
— interface-id ifindex
— interface-id sap-id
— interface-id string string
— no interface-id
— [no] remote-id
— [no] override-slaac
— pd-managed-route [next-hop {ipv4 | ipv6}]
— no pd-managed-route
— [no] proxy-server
— client-applications [dhcp] [ppp]
— no client-applications
— preferred-lifetime [days days] [hrs hours] [min minutes] [sec seconds]
— preferred-lifetime infinite
— no preferred-lifetime
— rebind-timer [days days] [hrs hours] [min minutes] [sec seconds]
— no rebind-timer
— renew-timer [days days] [hrs hours] [min minutes] [sec seconds]
— no renew-timer
— server-id duid-en hex hex-string
— server-id duid-en string ascii-string
— server-id duid-ll
— no server-id
— [no] shutdown
— valid-lifetime [valid-lifetime]
— valid-lifetime infinite
— no valid-lifetime
— python-policy name
— no python-policy
— [no] relay
— client-applications [dhcp] [ppp]
— no client-applications
— description description-string
— no description
— link-address ipv6-address
— no link-address
— server [ipv6-address]
— no server
— [no] shutdown
— source-address ipv6-address
— no source-address
— [no] snooping
— [no] shutdown
— user-db local-user-db-name
— no user-db
— user-ident user-ident
— no user-ident

3.6.1.5.1. VPRN Local DHCP Server Commands

config
— service
— vprn
— dhcp
— dhcp6
— local-dhcp-server server-name [create]
— no local-dhcp-server server-name
— [no] allow-lease-query
— description description-string
— no description
— failover
— [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] [hrs hours]
— [no] force-renews
— [no] ignore-rapid-commit
— [no] interface-id-mapping
— lease-hold-time [lease-hold-time]
— no lease-hold-time
— [no] lease-hold-time-for
— [no] internal-lease-ipsec
— [no] solicited-release
— pool pool-name [create]
— no pool pool-name
— delegated-prefix-length bits [minimum prefix-length] [maximum prefix-length]
— no delegated-prefix-length
— description description-string
— no description
— [no] exclude-prefix ipv6-prefix/prefix-length
— failover
— [no] ignore-mclt-on-takeover
— maximum-client-lead-time [maximum-client-lead-time]
— no maximum-client-lead-time
— partner-down-delay [partner-down-delay]
— no partner-down-delay
— peer ip-address tag sync-tag
— no peer
— [no] shutdown
— [no] startup-wait-time [min minutes] [sec seconds [hrs hours]
— max-lease-time [max-lease-time]
— no max-lease-time
— min-lease-time [min-lease-time]
— no min-lease-time
— minimum-free minimum-free [percent] [event-when-depleted]
— no minimum-free
— [no] nak-non-matching-subnet
— offer-time [min minutes] [sec seconds]
— no offer-time
— options
— custom-option option-number address ip-address [ip-address]
— custom-option option-number domain domain-string
— custom-option option-number hex hex-string
— custom-option option-number string ascii-string
— no custom-option option-number
— dns-server ip-address [ip-address]
— no dns-server
— domain-name domain-name
— no domain-name
— lease-rebind-time [days days] [hrs hours] [min minutes] [sec seconds]
— no lease-rebind-time
— lease-renew-time [days days] [hrs hours] [min minutes] [sec seconds]
— no lease-renew-time
— lease-time [days days] [hrs hours] [min minutes] [sec seconds]
— no lease-time
— netbios-name-server ip-address [ip-address]
— no netbios-name-server
— netbios-node-type netbios-node-type
— no netbios-node-type
— prefix ipv6-addr/prefix-len [failover {local | remote | access-driven}] [pd] [wan-host] [create]
— no prefix ipv6-addr/prefix-len
— [no] drain
— options
— custom-option option-number address address [address]
— custom-option option-number domain domain-string
— custom-option option-number hex hex-string
— custom-option option-number string ascii-string
— no custom-option option-number
— dns-server ipv6-address [ipv6-option]
— no dns-server
— domain-name domain-name
— no domain-name
— preferred-lifetime [days days] [hrs hours] [min minutes] [sec seconds]
— no preferred-lifetime
— rebind-timer [rebind-timer]
— no rebind-timer
— renew-timer [renew-timer]
— no renew-timer
— thresholds
— [no] minimum-free prefix-length [prefix-length]
— [no depleted-event
— minimum [percent [percent]] [number [number]]
— no minimum
— valid-lifetime [days days] [hrs hours] [min minutes] [sec seconds]
— no valid-lifetime
— 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 [failover {local | remote| access-driven}]
— [no] drain
— [no] exclude-addresses start-ip-address [end-ip-address]
— maximum-declined maximum-declined
— no maximum-declined
— minimum-free minimum-free [percent] [event-when-depleted]
— no minimum-free
— options
— custom-option option-number address [ip-address]
— 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]
— no default-router
— subnet-mask ip-address
— no subnet-mask
— server-id duid-en hex hex-string
— server-id duid-en string ascii-string
— server-id duid-ll
— no server-id
— [no] shutdown
— use-gi-address [scope scope]
— no use-gi-address
— use-link-address [scope scope]
— no use-link-address
— use-pool-from-client
— use-pool-from-client delimiter delimiter
— no use-pool-from-client
— user-db local-user-db-name
— no user-db
— user-ident {client-id | circuit-id | mac | mac-circuit-id | remote-id}
— no user-ident
— [no] interface ip-int-name [create]
— dhcp
— description description-string
— no description
— gi-address ip-address [src-ip-addr]
— no gi-address
— lease-populate [nbr-of-leases]
— no lease-populate
— [no] option
— action {replace | drop | keep}
— no action
— circuit-id [ascii-tuple | ifindex | sap-id | vlan-ascii-tup]
— no circuit-id
— remote-id [mac | string string]
— no remote-id
— [no] vendor-specific-option
— [no] client-mac-address
— [no] pool-name
— [no] sap-id
— [no] service-id
— string text
— no string
— [no] system-id
— proxy-server
— emulated-server ip-address
— no emulated-server
— lease-time [lease-time] [override]
— no lease-time
— [no] shutdown
— python-policy policy-name
— no python-policy
— [no] relay-plain-bootp
— relay-proxy [release-update-src-ip] [siaddr-override ip-address]
— no relay-proxy
— server server1 [server2.]
— no server
— [no] shutdown
— [no] trusted
— [no] use-arp
— [no] ipv6
— address ipv6-address/prefix-length [eui-64]
— no address ipv6-address/prefix-length
— [no] dhcp6-relay
— description description-string
— no description
— dhcp6-relay [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]
— no lease-populate
— link-address ipv6-address
— no link-address
— [no] neighbor-resolution
— [no] option
— interface-id
— interface-id [ascii-tuple]
— interface-id ifindex
— interface-id sap-id
— interface-id string
— no interface-id
— [no] remote-id
— python-policy name
— no python-policy
— server ipv6z-address [ipv6z-address]
— no server [ipv6z-address]
— [no] shutdown
— source-address ipv6-address
— no source-address
— user-db local-user-db-name
— no user-db
— [no] use-arp
— [no] dhcp6-server
— max-nbr-of-leases max-nbr-of-leases
— no max-nbr-of-leases
— [no] prefix-delegation
— [no] prefix ipv6-address/prefix-length
— duid duid [iaid iaid]
— no duid
— preferred-lifetime seconds
— preferred-lifetime infinite
— no preferred-lifetime
— valid-lifetime seconds
— valid-lifetime infinite
— no valid-lifetime
— [no] shutdown
— [no] subscriber-interface ip-int-name [create]
— local-address-assignment
— client-application [ppp-v4] [ipoe-v4]
— no client-application
— default-pool pool-name [secondary pool-name]
— no default-pool
— server server-name
— no server
— [no] shutdown

3.6.1.5.2. VPLS DHCP Commands

config
— service
— vpls service-id [customer customer-id] [create] [vpn vpn-id] [m-vpls] [b-vpls | i-vpls] [etree] [name name]
— no vpls service-id
— sap sap-id [split-horizon-group group-name] [capture-sap] [create]
— no sap sap-id
— dhcp
— description description-string
— no description
— lease-populate [nbr-of-leases]
— no lease-populate
— [no] option
— action dhcp-action
— no action
— circuit-id
— circuit-id {ascii-tuple | vlan-ascii-tuple}
— circuit-id hex [0x0..0xFFFFFFFF...(64 hex nibbles)]
— no circuit-id
— remote-id
— remote-id hex [0x0..0xFFFFFFFF...(64 hex nibbles)]
— remote-id mac
— remote-id string string
— no remote-id
— [no] vendor-specific-option
— [no] client-mac-address
— [no] sap-id
— [no] service-id
— string text
— no string
— [no] system-id
— proxy-server
— emulated-server ip-address
— no emulated-server
— lease-time [days days] [hrs hours] [min minutes] [sec seconds] [override]
— no lease-time
— [no] shutdown
— [no] shutdown
— [no] snoop
— dhcp-user-db local-user-db-name
— no dhcp-user-db
— dhcp-python-policy policy-name
— no dhcp-python-policy
— dhcp6-user-db local-user-db-name
— no dhcp6-user-db
— dhcp6
— description description-string
— no description
— [no] option
— interface-id
— interface-id ascii-tuple
— interface-id vlan-ascii-tuple
— no interface-id
— remote-id
— remote-id string [string]
— remote-id mac
— no remote-id
— [no] shutdown
— [no] snoop
— mesh-sdp sdp-id[:vc-id] [vc-type {ether | vlan}] [create]
— dhcp
— description description-string
— no description
— [no] snoop
— spoke-sdp sdp-id[:vc-id] [vc-type {ether | vlan}] [split-horizon-group group-name] [create]
— dhcp
— description description-string
— no description
— [no] snoop

3.6.1.5.3. Anti-Spoof Filtering Commands

Note:

  1. DHCP commands described in this section are applicable to the anti-spoofing feature.
config
— service
— ies service-id/vprn service-id
— no ies/vprn service-id
— interface ip-int-name [create]
— interface ip-int-name [create] tunnel
— no interface ip-int-name
— sap sap-id [create]
— no sap sap-id
— anti-spoof {type}
— no anti-spoof
— filter
— description description-string
— no description
— gi-address ip-address [src-ip-addr]
— no gi-address
— lease-populate nbr-of-leases
— no lease-populate
— option
— action {replace | drop | keep}
— no action
— circuit-id [ascii-tuple | ifindex | sap-id | vlan-ascii-tuple]
— no circuit-id
— [no] remote-id
— [no] relay-plain-bootp
— relay-proxy [release-update-src-ip] [siaddr-override ip-address]
— no relay-proxy
— server server1 [server2]
— no server
— [no] shutdown
— [no] trusted
config
— service
— vpls service-id [customer customer-id] [create] [vpn vpn-id] [m-vpls] [b-vpls | i-vpls] [etree] [name name]
— no vpls service-id
— sap sap-id [split-horizon-group group-name] [create] [capture-sap] [eth-ring ring-index]
— sap sap-id [split-horizon-group group-name] [create] [capture-sap] [eth-ring ring-index] leave-ac
— sap sap-id [split-horizon-group group-name] [create] [capture-sap] [eth-ring ring-index] root-leaf-tag leaf-tag leaf-tag
— no sap sap-id
— anti-spoof {type}
— no anti-spoof
— dhcp
— description description-string
— no description
— lease-populate [nbr-of-leases]
— no lease-populate
— [no] option
— option [dhcp-action]
— no option
— circuit-id
— circuit-id {ascii-tuple | vlan-ascii-tuple}
— circuit-id hex [0x0..0xFFFFFFFF...(64 hex nibbles)]
— no circuit-id
— [no] remote-id
— [no] shutdown
— [no] snoop
— mesh-sdp sdp-id[:vc-id] [vc-type {ether | vlan}] [create]
— mesh-sdp sdp-id[:vc-id] [vc-type {ether | vlan}] [create] leaf-ac
— mesh-sdp sdp-id[:vc-id] [vc-type {ether | vlan}] [create] root-leaf-tag
— no mesh-sdp sdp-id[:vc-id]
— mesh-sdp sdp-id[:vc-id] [vc-type {ether | vlan}] [create]
— mesh-sdp sdp-id[:vc-id] [vc-type {ether | vlan}] [create] leaf-ac
— dhcp
— description description-string
— no description
— [no] snoop
— spoke-sdp sdp-id[:vc-id] [vc-type {ether | vlan}] [split-horizon-group group-name]
— no spoke-sdp sdp-id[:vc-id]
— dhcp
— description description-string
— no description
— [no] snoop

3.6.1.6.  System DHCP Commands

config
— system
— dhcp6
— adv-noaddrs-global [esm-proxy] [esm-relay] [relay] [server]
— no adv-noaddrs-global

3.6.1.7. Show Commands

show
— router
— dhcp
— local-dhcp-server server-name
— associations
— declined-addresses ip-address[/mask] [detail]
— declined-addresses pool pool-name
— failover-pool-stats [pool-name]
— failover-server-stats
— free-addresses ip-address[/mask]
— free-addresses summary [subnet ip-address[/mask]
— free-addresses pool pool-name
— leases [detail]
— 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] [state]
— pool-ext-stats [pool-name]
— server-stats
— sticky-leases [hostname]
— subnet-ext-stats ip-address[/mask]
— subnet-ext-stats pool pool-name
— subnet-stats ip-address[/mask]
— subnet-stats pool pool-name
— summary
— servers
— servers all
— statistics [interface ip-int-name | ip-address]
— summary
— router
— dhcp6
— local-dhcp-server server-name
— associations
— failover-pool-stats [pool-name]
— failover-server-stats
— interface-id-mapping
— leases [ipv6-address/prefix-length] [type] [state] [detail]
— pool-ext-stats [pool-name]
— pool-stats [pool-name]
— pool-threshold-stats [pool-name] detail [format {exact | scientific}]
— pool-threshold-stats [pool-name]
— prefix-ext-stats ipv6-address/prefix-length
— prefix-ext-stats pool pool-name
— prefix-stats ipv6-address/prefix-length
— prefix-stats pool pool-name
— 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
— server-stats
— servers
— servers all
— statistics
— summary
show
— service
— id service-id
— dhcp
— 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]]
— summary [interface interface-name | saps]
— dhcp6
— lease-state [detail] [wholesaler service-id] [session {none | ipoe | ppp}] [router-advertisement-policy policy-name]
— lease-state [detail] interface interface-name [wholesaler service-id] [session {none | ipoe | ppp}] [router-advertisement-policy policy-name]
— lease-state [detail] ipv6-address ipv6-prefix[/prefix-length] [wholesaler service-id] [session {none | ipoe | ppp}] [router-advertisement-policy policy-name]
— lease-state [detail] mac ieee-address [wholesaler service-id] [session {none | ipoe | ppp}] [router-advertisement-policy policy-name]
— statistics [interface interface-name]
— summary
— summary interface interface-name
— summary saps
— ppp
— session [user-name user-name] [sub-ppp-type {oa | oe | oeoa | ol2tp}] [interface ip-int-name | ip-address] [inter-dest-id intermediate-destination-id] [no-inter-dest-id] [ip-address ip-prefix[/prefix-length]] [port port-id] [sap sap-id] [termination-type ppp-session-type] [mlppp] [steering-profile steering-profile] [circuit-id circuit-id] [remote-id remote-id]
— session [user-name user-name] [circuit-id circuit-id] [remote-id remote-id] detail
— session [user-name user-name] [circuit-id circuit-id] [remote-id remote-id] statistics
— statistics
— statistics interface [ip-int-name | ip-address]
— statistics sap sap-id
— summary
— virtual-subnet subscriber sub-ident
— virtual-subnet [sap sap-id]
show
— system
— dhcp6

3.6.1.8. Clear Commands

clear
— router
— dhcp
— local-dhcp-server server-name
— declined-addresses ip-address[/mask]
— declined-addresses pool pool-name
— failover-pool-stats [pool-name]
— leases ip-address[/mask] [state]
— leases all [state]
— pool-ext-stats [pool-name]
— server-stats
— sticky-leases hostname hostname
— sticky-leases hostname-prefix hostname-prefix
— subnet-ext-stats ip-address[/mask]
— subnet-ext-stats pool pool-name
— statistics [ip-int-name | ip-address]
— dhcp6
— local-dhcp-server server-name
— failover-pool-stats [pool-name]
— leases [ipv6-address/prefix-length] [type] [state]
— leases all [type] [state]
— pool-ext-stats [pool-name]
— pool-threshold-stats [pool-name]
— pool-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
— server-stats
— statistics
— service
— id service-id
— dhcp
— lease-state all [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[/mask] [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]
— dhcp6
— lease-state all [no-dhcp-release]
— lease-state ipv6-address ipv6-prefix[/prefix-length] [no-dhcp-release]
— lease-state mac ieee-address [no-dhcp-release]
— lease-state sap sap-id [no-dhcp-release]
— statistics [interface ip-int-name | ipv6-address]

3.6.1.9. Debug Commands

debug
— router router-instance
— ip
— [no] dhcp [interface ip-int-name]
— [no] dhcp mac ieee-address
— [no] dhcp sap sap-id
— detail-level {low | medium | high}
— no detail-level
— mode {dropped-only | ingr-and-dropped | egr-ingr-and-dropped}
— no mode
— dhcp6 [interface ip-int-name]
— no dhcp6
— detail-level {low | medium | high}
— no detail-level
— mode {dropped-only | ingr-and-dropped | egr-ingr-and-dropped}
— no mode
— [no] local-dhcp-server server-name [lease-address ip-prefix[/prefix-length]]
— [no] local-dhcp-server server-name [mac ieee-address]
— [no] local-dhcp-server server-name link-local-address ipv6z-address
— detail-level {low | medium | high}
— no detail-level
— mode {dropped-only | ingr-and-dropped | egr-ingr-and-dropped}
— no mode

3.6.1.10. Tools Commands

tools
— perform
— subscriber-mgmt
— local-user-db local-user-db-name
— ipoe
— 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] [c0ircuit-id circuit-id | circuit-id-hex circuit-id-hex] [option60-hex option60-hex] [remote-id-hex remote-id-hex] [derived-id derived-id] [ip-prefix ip-prefix/ip-prefix-length]
— ppp
— authentication user-name user-name password password [circuit-id circuit-id] [circuit-id-hex circuit-id-hex] [derived-id derived-id] [mac ieee-address] [remote-id remote-id] [remote-id-hex remote-id-hex] [sap-id sap-id] [service-name service-name]
— host-lookup [circuit-id circuit-id] [circuit-id-hex circuit-id-hex] [derived-id derived-id] [mac ieee-address] [remote-id remote-id] [remote-id-hex remote-id-hex] [sap-id sap-id] [service-name service-name] [user-name user-name]
— router
— dhcp
— local-user-db server-name
— failover
— abort-startup-wait
— force-partner-down
— pool pool-name
— create-sticky-lease host-name [mac ieee-address] [circuit-id circuit-id] [client-id client-id] [requested-ip-address ip-address] [circuit-id-hex circuit-id-hex-string] [client-id-hex client-id-hex-string]
— failover
— abort-startup-wait
— force-partner-down
— send-force-renew ip-address
— dhcp6
— local-user-db server-name
— failover
— abort-startup-wait
— force-partner-down
— pool pool-name
— failover
— abort-startup-wait
— force-partner-down
— dump
— dhcp-rx-stats [clear]

3.6.2. Command Descriptions

3.6.2.1. Triple Play DHCP Configuration Commands

3.6.2.1.1. Global Commands

description

Syntax 
description description-string
no description
Context 
config>filter>dhcp-filter
config>router>dhcp>server
config>router>dhcp6>server
config>router>dhcp>server>pool
config>router>dhcp6>server>pool
config>service>ies>if>dhcp
config>service>ies>if>ipv6>dhcp6-relay
config>service>ies>sub-if>grp-if>ppp
config>service>ies>sub-if>ipv6>dhcp6>relay
config>service>vpls>sap>dhcp
config>service>vpls>sap>ipoe-session
config>service>vpls>sap>dhcp6
config>service>vprn>if>dhcp
config>service>vprn>sub-if>ipv6>dhcp6>relay
config>subscr-mgmt>loc-user-db
Description 

This command creates a text description stored in the configuration file for a configuration context.

The description command associates a text string with a configuration context to help identify the content in the configuration file.

The no form of this command removes the string from the configuration.

Parameters 
description-string—
Specifies the description character string. Allowed values are any string, up to 80 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

shutdown

Syntax 
[no] shutdown
Context 
config>router>dhcp>server>failover
config>router>dhcp6>server>failover
config>service>ies>if>dhcp
config>service>vpls>sap>dhcp
config>service>vpls>sap>dhcp>option>vendor
config>service>vpls>sap>ipoe-session
config>service>vprn>if>dhcp
config>service>vprn>if>dhcp>proxy-server
config>subscr-mgmt>loc-user-db
config>subscr-mgmt>loc-user-db>ipoe>host
config>subscr-mgmt>loc-user-db>ppp>host
config>subscr-mgmt>msap-policy>vpls-only>dhcp>option>proxy-server
Description 

This command administratively disables the entity. When disabled, an entity does not change, reset, or remove any configuration settings or statistics. Many entities must be explicitly enabled using the no shutdown command. The operational state of the entity is disabled as well as the operational state of any entities contained within. Many objects must be shut down before they may be deleted.

Unlike other commands and parameters where the default state is not indicated in the configuration file, shutdown and no shutdown are always indicated in system-generated configuration files.

The no form of this command places the entity into an administratively enabled state.

3.6.2.1.2. DHCP Filter Commands

dhcp-filter

Syntax 
dhcp-filter filter-id [create]
no dhcp-filter
Context 
config>filter
Description 

This command creates a configuration context for the specified DHCP filter policy if it does not exist and enables the context to configure the specified DHCP filter policy.

Parameters 
filter-id—
Specifies the DHCP filter policy ID expressed as a decimal integer.
Values—
1 to 65535

 

create—
Keyword required to create the configuration context.

dhcp6-filter

Syntax 
dhcp6-filter filter-id [create]
no dhcp6-filter
Context 
config>filter
Description 

This command creates a configuration context for the specified DHCPv6 filter policy if it does not exist and enables the context to configure the specified DHCPv6 filter policy.

The no form of this command reverts to the default.

Parameters 
filter-id—
Specifies the DHCPv6 filter policy ID expressed as a decimal integer.
Values—
1 to 65535

 

create—
Keyword required to create the configuration context.

default-action

Syntax 
default-action {bypass-host-creation | drop}
no default-action
Context 
config>filter>dhcp-filter
Description 

This command specifies the default action for DHCP filters when no entries match.

The no form of this command reverts to the default.

Parameters 
bypass-host-creation—
Specifies to bypass ESM host creation options.
drop—
Specifies to drop and not process the DHCP message.

default-action

Syntax 
default-action bypass-host-creation [na] [pd]
default-action drop
no default-action
Context 
config>filter>dhcp6-filter
Description 

This command specifies the default action for DHCP6 filters when no entries match.

The no form of this command reverts to the default.

Parameters 
bypass-host-creation—
Specifies to bypass ESM host creation options.
Values—
na — Bypasses the DHCP NA hosts creation.
pd — Bypasses the DHCP PD hosts creation.

 

drop—
Specifies to drop and not process the DHCP6 message.

entry

Syntax 
entry entry-id [create]
no entry entry-id
Context 
config>filter>dhcp-filter
config>filter>dhcp6-filter
Description 

This command configures DHCP filter entries.

The no form of this command removes the entry from the configuration.

Parameters 
entry-id—
Specifies the entry ID.
Values—
1 to 65535

 

create—
This keyword is required when first creating the DHCP filter entry. Once the context is created, it is possible to navigate into the context without the create keyword.

action

Syntax 
action bypass-host-creation
action drop
no action
Context 
config>filter>dhcp-filter>entry
Description 

This command specifies the action to take on DHCP host creation when the filter entry matches.

The no form of this command reverts to the default wherein the host creation proceeds as normal.

Parameters 
bypass-host-creation—
Specifies that the host creation is bypassed.
drop —
Specifies that the DHCP message is dropped.

action

Syntax 
action bypass-host-creation [na] [pd]
action drop
no action
Context 
config>filter>dhcp6-filter>entry
Description 

This command specifies the action to take on DHCP6 host creation when the filter entry matches.

The no form of this command reverts to the default wherein the host creation proceeds as normal.

Parameters 
bypass-host-creation—
Specifies that the host creation is bypassed.
Values—
na — Bypasses the DHCP6 NA hosts creation.
pd — Bypasses the DHCP6 PD hosts creation.

 

drop —
Specifies that the DHCP6 message is dropped.

option

Syntax 
option dhcp-option-number {present | absent}
option dhcp-option-number match hex hex-string [exact] [invert-match]
option dhcp-option-number match string ascii-string [exact] [invert-match]
no option
Context 
config>filter>dhcp-filter>entry
Description 

This command configures match criteria for the DHCP filter policy entry.

The no form of this command reverts to the default

Parameters 
dhcp-option-number—
Specifies the DHCP option number.
Values—
0 to 255

 

present —
Specifies that the related DHCP option must be present.
absent—
Specifies that the related DHCP option must be absent.
hex-string—
Specifies that option must partially match a specified hex string.
Values—
0x0 to 0xFFFFFFFF (up to 254 hex nibbles)

 

ascii-string—
The option must partially match a specified ASCII string, up to 127 characters.
exact—
Specifies that this option requires an exact match of a hex or ASCII string.
invert-match—
Requires the option not to partially match.

option

Syntax 
option dhcp6-option-number {present | absent}
option dhcp6-option-number match hex hex-string [exact] [invert-match]
option dhcp6-option-number match string ascii-string [exact] [invert-match]
no option
Context 
config>filter>dhcp6-filter>entry
Description 

This command configures match criteria for the DHCP6 filter policy entry.

The no form of this command reverts to the default.

Parameters 
dhcp-option-number—
Specifies the DHCP6 option number.
Values—
0 to 255

 

present —
Specifies that the related DHCP6 option must be present.
absent—
Specifies that the related DHCP6 option must be absent.
match hex hex-string—
The option must (partially) match a specified hex string.
Values—
0x0 to 0xFFFFFFFF (up to 254 hex nibbles)

 

match string ascii-string—
The option must partially match a specified ASCII string, up to 127 characters.
exact—
Specifies that this option requires an exact match of a hex or ASCII string.
invert-match—
Requires the option not to partially match.

3.6.2.1.3. Subscriber Management Local User Database Commands

subscriber-mgmt

Syntax 
subscriber-mgmt
Context 
config>subscr-mgmt
Description 

This command enables the context to configure subscriber management parameters.

local-user-db

Syntax 
local-user-db local-user-db-name [create]
no local-user-db local-user-db-name
Context 
config>subscr-mgmt
Description 

This command enables the context to configure a local user database.

The no form of this command reverts to the default.

Parameters 
local-user-db-name —
Specifies the name of a local user database.

ipoe

Syntax 
ipoe
Context 
config>subscr-mgmt>loc-user-db
Description 

This command enables the context to configure IPoE host parameters.

host

Syntax 
host host-name [create]
no host host-name
Context 
config>subscr-mgmt>loc-user-db>ipoe
config>subscr-mgmt>loc-user-db>ppp
Description 

This command defines a DHCP or PPP subscriber.

The no form of this command removes the host name from the configuration.

Parameters 
host-name—
Specifies the host name.
create—
Keyword used to create the host name. The create keyword requirement can be enabled or disabled in the environment>create context.

acct-policy

Syntax 
acct-policy acct-policy-name [duplicate acct-policy-name]
no acct-policy
Context 
config>subscr-mgmt>loc-user-db>ipoe>host
config>subscr-mgmt>loc-user-db>ppp>host
Description 

This command specifies the accounting policy used for sending an Accounting Stop message to report RADIUS authentication failures of PPPoE sessions. A duplicate policy can be specified if a copy of the Accounting Stop message must be sent to another destination.

Reporting RADIUS authentication failures with an Accounting Stop message must be enabled in the RADIUS authentication policy (“send-acct-stop-on-fail”).

A duplicate RADIUS accounting policy can be specified if the accounting stop resulting from a RADIUS authentication failure must also be sent to a second RADIUS destination.

The no form of this command reverts to the default.

Parameters 
acct-policy-name—
Specifies the name of a RADIUS accounting policy, up to 32 characters.

address

Syntax 
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]
no address
Context 
config>subscr-mgmt>loc-user-db>ipoe>host
config>subscr-mgmt>loc-user-db>ppp>host
Description 

This command configures how the IP address is defined for this host.

When the user database is used from a local DHCP server, then this command defines how to define the IP address the server will offer to the DHCP-client.

When the user-db is used for PPPoE authentication, the gi-address parameter cannot be used. A fixed IP address will then cause PPPoE to use this IP address. If no IP address is specified, the PPPoE looks for IP address by other means (DHCP). If a pool name is given, this pool will be sent in the DHCP request so that it can be used in by the DHCP server to determine which address to give to the host.

The no form of this command causes no IP address to be assigned to this host. In a user database referred to from a local DHCP server, creating a host without address information will cause the matching client never to get an IP address.

The no form of this command reverts to the default.

Parameters 
gi-address—
When specified, the gi-address of the DHCP message is taken to look for a subnet in the local DHCP server. The first available free address of the subnet is taken and “offered” to the host. When local-user-db is used for PPPoE authentication, this has the same result as no address.
ip-address—
Specifies the fixed IP address to use for this host.
pool-name/sec-pool-name—
Specifies the primary (and secondary) pool (in the local DHCP server) to use to look for an available address. The first available IP address from any subnet in the pool will be used. When the local user database is used for PPPoE authentication, this causes the specified pool name to be sent to the DHCP server in a vendor-specific sub-option under Option 82.
use-pool-from-client—
Use the pool-name in the Option 82 vendor-specific sub-option.
delimiter—
A single ASCII character specifies the delimiter of separating primary and secondary pool names in option82 VSO.

auth-domain-name

Syntax 
auth-domain-name domain-name
no auth-domain-name
Context 
config>subscr-mgmt>loc-user-db>ipoe>host
Description 

This command sets the domain name which can be appended to user-name in RADIUS-authentication-request message for the given host.

The no form of this command removes the domain name from the host configuration.

Parameters 
domain-name—
Specifies the domain name, up to 32 characters, to be appended to user-name in RADIUS-authentication-request message for the given host

auth-policy

Syntax 
auth-policy policy-name
no auth-policy
Context 
config>subscr-mgmt>loc-user-db>ipoe>host
config>subscr-mgmt>loc-user-db>ppp>host
Description 

This command configures the authentication policy of this host and PPPoE hosts. This authentication policy is only used if no authentication policy is defined at the interface level. For DHCP hosts, the host entry should not contain any other information needed for setup of the host (IP address, ESM strings, and so on.). For PPPoE hosts, the authentication policy configured here must have its PPPoE authentication method set to pap-chap, otherwise the request is dropped.

The no form of this command reverts to the default.

Parameters 
policy-name—
Specifies the authentication policy name, up to 32 characters

diameter-application-policy

Syntax 
diameter-application-policy policy-name
no diameter-application-policy
Context 
config>subscr-mgmt>loc-user-db>ipoe>host
config>subscr-mgmt>loc-user-db>ppp>host
Description 

This command configures the Diameter application policy.

The no form of this command reverts to the default.

Parameters 
policy-name—
Specifies the Diameter application policy name.

diameter-auth-policy

Syntax 
diameter-auth-policy name
no diameter-auth-policy
Context 
config>subscr-mgmt>loc-user-db>ipoe>host
config>subscr-mgmt>loc-user-db>ppp>host
Description 

This command is used to configure the Diameter NASREQ application policy to use for authentication.

The no form of this command reverts to the default.

Parameters 
name—
Specifies the name of the Diameter NASREQ application policy to use for authentication.

gi-address

Syntax 
gi-address ip-address
no gi-address
Context 
config>subscr-mgmt>loc-user-db>ipoe>host
Description 

This command allows selection of GI addresses based on the host entry in LUDB.

The gi-address must be a valid address (associated with an interface) within the routing context that received the DHCP message on the access side.

The no form of this command reverts to the default.

Parameters 
ip-address—
Specifies the IPv4 gi-address.

host-identification

Syntax 
host-identification
Context 
config>subscr-mgmt>loc-user-db>ipoe>host
config>subscr-mgmt>loc-user-db>ppp>host
Description 

This command enables the context to configure host identification parameters.

circuit-id

Syntax 
circuit-id string ascii-string
circuit-id hex hex-string
no circuit-id
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>host-ident
config>subscr-mgmt>loc-user-db>ppp>host>host-ident
Description 

This command specifies the circuit-id to match.

The no form of this command reverts to the default.

Parameters 
ascii-string—
Specifies the circuit ID from the Option 82.
hex-string—
Specifies the circuit ID in hexadecimal format from the Option 82.
Values—
0x0 to 0xFFFFFFFF (maximum 254 hex nibbles)

 

derived-id

Syntax 
derived-id derived-id-string
no derived-id
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>host-ident
config>subscr-mgmt>loc-user-db>ppp>host>host-ident
Description 

This command configures an ASCII string that uniquely identifies a host and is derived by a Python script from packet content available during a DHCP transaction.

The no form of this command reverts to the default.

Parameters 
derived-id-string—
Specifies the host ID to be derived by a python script from DHCP packets during a DHCP transaction, up to 255 characters

encap-tag-range

Syntax 
encap-tag-range start-tag start-tag end-tag end-tag
no encap-tag-range
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>host-ident
config>subscr-mgmt>loc-user-db>ppp>host>host-ident
Description 

This command specifies a range of encapsulation tag as the host identifications. The encapsulation tag is dot1q or qinq on Ethernet port; VPI/VCI on ATM port.

For dot1q, the start/end-tag is single number, range from 0-4094; for QinQ, the start/end-tag format is x.y, x or y could be “*”, which means ignore inner or outer tag;

For ATM the start/end-tag format is vpi/vci, vpi or vci could be “*”, which means ignore VPI or VCI.

Note:

This command is only used when encap-tag-range is configured as one of the match-list parameters.

The no form of this command reverts to the default.

Parameters 
start-tag start-tag —
Specifies the value of the start label in the range of SAPs allowed on this host.
Values—

start-tag

dot1q

qtag1

qinq

(qtag1.qtag2 | qtag1.* | *.qtag2)

atm

(vpi/vci | vpi/* | */vci)

qtag1

[0 to 4094]

qtag2

[0 to 4094]

vpi

[0 to 4095] (NNI)

[0 to 255] (UNI)

vci

[1 to 65535]

 

end-tag end-tag—
Specifies the value of the end label in the range of SAPs allowed on this host.
Values—

end-tag

dot1q

qtag1

qinq

(qtag1.qtag2 | qtag1.* | *.qtag2)

atm

(vpi/vci | vpi/* | */vci)

qtag1

[0 to 4094]

qtag2

[0 to 4094]

vpi

[0 to 4095] (NNI)

[0 to 255] (UNI)

vci

[1 to 65535]

 

ip-prefix

Syntax 
ip-prefix ip-prefix/ip-prefix-length
no ip-prefix
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>host-ident
Description 

This command specifies the source IPv4/IPv6 address/prefix of the data trigger packet as the host identification.

The no form of this command reverts to the default.

Parameters 
ip-prefix/ip-prefix-length—
Specifies the IPv4 address, IPv6 address, or IPv6 prefix
Values—
ipv4-prefix               a.b.c.d
ipv4-prefix-length    [0 to 32]
ipv6-prefix                x:x:x:x:x:x:x:x (eight 16-bit pieces)
                                  x:x:x:x:x:x:d.d.d.d
                                  x to [0 to FFFF]H
                                  d to [0 to 255]D
ipv6-prefix-length    [0 to 128]

 

mac

Syntax 
mac ieee-address
no mac
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>host-ident
config>subscr-mgmt>loc-user-db>ppp>host>host-ident
Description 

This command specifies the MAC address to match.

The no form of this command reverts to the default.

Parameters 
ieee-address—
Specifies the 48-bit MAC address in the form aa:bb:cc:dd:ee:ff or aa-bb-cc-dd-ee-ff where aa, bb, cc, dd, ee, and ff are hexadecimal numbers

option60

Syntax 
option60 hex hex-string
option60 string ascii-string
no option60
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>host-ident
Description 

This command specifies the Vendor-Identifying Vendor Option to match. Option 60 is encoded as Type-Length-Value (TLV). The hex-string portion of Option 60 in the received DHCP request is used for matching. Only the first 32 bytes can be defined here. If Option 60 from the message is longer, those bytes are ignored.

The no form of this command reverts to the default.

Parameters 
hex-string—
Specifies the hexadecimal format for this option.
Values—
0x0 to 0xFFFFFFFF(maximum 64 hex nibbles)

 

ascii-string—
Specifies the string format for this option, up to 32 characters.

remote-id

Syntax 
remote-id hex hex-string
remote-id string ascii-string
no remote-id
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>host-ident
config>subscr-mgmt>loc-user-db>ppp>host>host-ident
Description 

This command specifies the remote ID of this host.

The no form of this command returns to the default.

Parameters 
hex-string—
Specifies the hexadecimal format for the remote ID.
Values—
0x0 to 0xFFFFFFFF (maximum 254 hex nibbles)

 

ascii-string—
Specifies the string format for the remote ID, up to 255 characters.

sap-id

Syntax 
sap-id sap-id
no sap-id
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>host-ident
Description 

This command specifies the SAP ID from the Nokia vendor-specific sub-option in Option 82 to match.

The no form of this command returns to the default.

Parameters 
sap-id—
Specifies a SAP ID, up to 255 characters.

service-id

Syntax 
service-id service-id
no service-id
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>host-ident
Description 

This command specifies an existing service ID from the Nokia vendor-specific sub-option in Option 82 to match.

The no form of this command returns to the default.

Parameters 
service-id—
Specifies an existing service ID or service name.
Values—
service-id — 1 to 2147483647
service-name — up to 64 characters

 

string

Syntax 
string string
no string
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>host-ident
Description 

This command specifies the string from the Nokia vendor-specific sub-option (VSO) in Option 82 to match.

The no form of this command returns to the default.

Parameters 
string—
Specifies the VSO string of this host, up to 255 characters.

system-id

Syntax 
system-id system-id
no system-id
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>host-ident
Description 

This command specifies the system ID from the Nokia vendor-specific sub-option in Option 82 to match.

The no form of this command returns to the default.

Parameters 
system-id—
Specifies the system ID, up to 255 characters

identification-strings

Syntax 
identification-strings option-number [create]
no identification-strings
Context 
config>subscr-mgmt>loc-user-db>ipoe>host
config>subscr-mgmt>loc-user-db>ppp>host
Description 

This command specifies identification strings for the subscriber. This is useful when the server is centralized with Enhanced Subscriber Management (ESM) in a lower level in the network. These strings will be parsed by a downstream Python script or they can be used literally if the strings-from-option option in the config>subscr-mgmt>sub-ident-policy context is set to this option number. In this case, the option number may be set to any allowed number (between 224 and 254 is suggested, as these are not dedicated to specific purposes). If the option number is not given, a default value of 254 is used. For PPPoE only, if the local user database is attached to the PPPoE node under the group interface and not to a local DHCP server, the strings will be used internally so the option number is not used.

The no form of this command returns to the default.

Parameters 
option-number—
Specifies identification strings for the subscriber.
Values—
1 to 254

 

ancp-string

Syntax 
ancp-string ancp-string
no ancp-string
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>ident-strings
config>subscr-mgmt>loc-user-db>ppp>host>ident-strings
Description 

This command specifies the ANCP string which is encoded in the identification strings.

The no form of this command returns to the default.

Parameters 
ancp-string—
Specifies the ANCP string, up to 63 characters.

app-profile-string

Syntax 
app-profile-string app-profile-string
no app-profile-string
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>ident-strings
config>subscr-mgmt>loc-user-db>ppp>host>ident-strings
Description 

This command specifies the application profile string which is encoded in the identification strings.

The no form of this command returns to the default.

Parameters 
app-profile-string—
Specifies the application profile string, up to 16 characters

category-map-name

Syntax 
category-map-name category-map-name [create]
no category-map-name category-map-name
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>ident-strings
config>subscr-mgmt>loc-user-db>ppp>host>ident-strings
Description 

This command specifies the category map name.

The no form of this command removes the category map name from the configuration.

Parameters 
category-map-name—
Specifies an existing category map name, up to 32 characters

inter-dest-id

Syntax 
inter-dest-id intermediate-destination-id
no inter-dest-id
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>ident-strings
config>subscr-mgmt>loc-user-db>ppp>host>ident-strings
Description 

This command specifies the intermediate destination identifier which is encoded in the identification strings.

The no form of this command returns to the default.

Parameters 
intermediate-destination-id—
Specifies the intermediate destination identifier, up to 32 characters.

sla-profile-string

Syntax 
sla-profile-string sla-profile-string
no sla-profile-string
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>ident-strings
config>subscr-mgmt>loc-user-db>ppp>host>ident-strings
Description 

This command specifies the SLA profile string which is encoded in the identification strings.

The no form of this command returns to the default.

Parameters 
sla-profile-string—
Specifies the SLA profile string, up to 16 characters.

sub-profile-string

Syntax 
sub-profile-string sub-profile-string
no sub-profile-string
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>ident-strings
config>subscr-mgmt>loc-user-db>ppp>host>ident-strings
Description 

This command specifies the subscriber profile string which is encoded in the identification strings.

The no form of this command returns to the default.

Parameters 
sub-profile-string—
Specifies the subscriber profile string, up to 16 characters.

ancp-string

Syntax 
ancp-string ancp-string
no ancp-string
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>ident-strings
config>subscr-mgmt>loc-user-db>ppp>host>ident-strings
Description 

This command specifies the ANCP string which is encoded in the identification strings.

The no form of this command returns to the default.

Parameters 
ancp-string—
Specifies the ANCP string, up to 63 characters.

app-profile-string

Syntax 
app-profile-string app-profile-string
no app-profile-string
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>ident-strings
config>subscr-mgmt>loc-user-db>ppp>host>ident-strings
Description 

This command specifies the application profile string which is encoded in the identification strings.

The no form of this command returns to the default.

Parameters 
app-profile-string—
Specifies the application profile string, up to 16 characters.

category-map-name

Syntax 
category-map-name category-map-name [create]
[no] category-map-name category-map-name
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>ident-strings
config>subscr-mgmt>loc-user-db>ppp>host>ident-strings
Description 

This command specifies the category map name.

The no form of this command removes the category map name from the configuration.

Parameters 
category-map-name—
Specifies an existing category map name, up to 32 characters.

inter-dest-id

Syntax 
inter-dest-id intermediate-destination-id
no inter-dest-id
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>ident-strings
config>subscr-mgmt>loc-user-db>ppp>host>ident-strings
Description 

This command specifies the intermediate destination identifier which is encoded in the identification strings.

The no form of this command returns to the default.

Parameters 
intermediate-destination-id—
Specifies the intermediate destination identifier, up to 32 characters.

sla-profile-string

Syntax 
sla-profile-string sla-profile-string
no sla-profile-string
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>ident-strings
config>subscr-mgmt>loc-user-db>ppp>host>ident-strings
Description 

This command specifies the SLA profile string which is encoded in the identification strings.

The no form of this command returns to the default.

Parameters 
sla-profile-string—
Specifies the SLA profile string, up to 16 characters.

spi-sharing-group-id

Syntax 
spi-sharing-group-id group-id
no spi-sharing-group-id
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>ident-strings
config>subscr-mgmt>loc-user-db>ppp>host>ident-strings
Description 

This command configures the SLA Profile Instance (SPI) sharing group identifier for an IPoE or PPPoE session. It overrides the default SPI sharing method (def-instance-sharing) configured in the SLA profile.

When an spi-sharing-group-id is configured, the IPoE or PPPoE session shares the SLA Profile Instance with other IPoE or PPPoE sessions from the same subscriber that: have the same SLA profile associated, are active on the same SAP, and have the same group identifier.

Configuring an spi-sharing-group-id group-id for an IPoE host, when the IPoE session is disabled on the group interface, results in a setup failure.

The no form of this command returns the SPI sharing group identifier to its default.

Parameters 
group-id—
Specifies the SPI group identifier.
Values—
0 to 65535

 

sub-profile-string

Syntax 
sub-profile-string sub-profile-string
no sub-profile-string
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>ident-strings
config>subscr-mgmt>loc-user-db>ppp>host>ident-strings
Description 

This command specifies the subscriber profile string which is encoded in the identification strings.

The no form of this command returns to the default.

Parameters 
sub-profile-string—
Specifies the subscriber profile string, up to 16 characters.

subscriber-id

Syntax 
subscriber-id sub-ident-string
no subscriber-id
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>ident-strings
config>subscr-mgmt>loc-user-db>ppp>host>ident-strings
Description 

This command specifies the subscriber ID which is encoded in the identification strings.

The no form of this command returns to the default.

Parameters 
sub-ident-string—
Specifies the subscriber ID string, up to 32 characters.

service-name

Syntax 
service-name service-name
no service-name
Context 
config>subscr-mgmt>loc-user-db>ppp>host>host-ident
Description 

This command specifies the service name tag in PADI and/or PADR packets to match for PPPoE hosts.

The no form of this command returns to the default.

Parameters 
service-name—
Specifies a PPPoE service name, up to 255 characters.

mask

Syntax 
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
Context 
config>subscr-mgmt>loc-user-db>ipoe
Description 

This command configures the IPoE mask.

The no form of this command removes the parameters from the mask configuration.

Parameters 
match-type—
Specifies up to four matching types to identify a host.
Values—
circuit-id, option60, remote-id, sap-id, string, system-id

 

prefix-string—
Specifies a substring that is stripped of the start of the incoming circuit ID before it is matched against the value configured in the circuit ID. This string can only contain printable ASCII characters. The “*” character is a wildcard that matches any substring. If a “\” character is masked, use the escape key so it becomes “\\”.
Values—
127 characters maximum, *' is a wildcard

 

prefix-length—
Specifies the number of characters to remove from the start of the incoming circuit ID before it is matched against the value configured in the circuit ID.
Values—
1 to 127

 

suffix-string—
Specifies a substring that is stripped of the end of the incoming circuit ID before it is matched against the value configured in the circuit ID.

This string can only contain printable ASCII characters. The “*” character is a wildcard that matches any substring. If a “\” character is masked, use the escape key so it becomes “\\”.

Values—
127 characters maximum

 

suffix-length—
Specifies the number of characters to remove from the end of the incoming circuit ID before it is matched against the value configured in the circuit ID.
Values—
1 to 127

 

mask

Syntax 
mask type ppp-match-type {[prefix-string prefix-string | prefix-length prefix-length] [suffix-string suffix-string | suffix-length suffix-length]}
no mask type ppp-match-type
Context 
config>subscr-mgmt>loc-user-db>ppp
Description 

This command configures the mask.

The no form of this command removes the parameters from the mask configuration.

Parameters 
ppp-match-type—
Specifies up to four matching types to identify a host.
Values—
circuit-id, remote-id, sap-id, service-name, username

 

prefix-string—
Specifies a substring that is stripped of the start of the incoming circuit ID before it is matched against the value configured in the circuit ID. This string can only contain printable ASCII characters. The “*” character is a wildcard that matches any substring. If a “\” character is masked, use the escape key so it becomes “\\”.
Values—
127 characters maximum, *' is a wildcard

 

prefix-length—
Specifies the number of characters to remove from the start of the incoming circuit ID before it is matched against the value configured in the circuit ID.
Values—
1 to 127

 

suffix-string—
Specifies a substring that is stripped of the end of the incoming circuit ID before it is matched against the value configured in circuit ID.

This string can only contain printable ASCII characters. The “*” character is a wildcard that matches any substring. If a “\” character is masked, use the escape key so it becomes “\\”.

Values—
127 characters maximum

 

suffix-length—
Specifies the number of characters to remove from the end of the incoming circuit ID before it is matched against the value configured in the circuit ID.
Values—
1 to 127

 

server

Syntax 
server ip-address
no server
Context 
config>subscr-mgmt>loc-user-db>ipoe>host
Description 

This command configures the IP address of the DHCP server to relay to.

The configured DHCP server IP address must reference one of the addresses configured under the DHCP CLI context of an IES/VPRN subscriber or group interface.

The no form of this command reverts to the default.

Parameters 
ip-address—
Specifies the IP address of the DHCP server.

username

Syntax 
username user-name
username user-name no-domain
username user-name domain-only
no username
Context 
config>subscr-mgmt>loc-user-db>ppp>host>host-ident
Description 

This command configures how the username is specified.

The no form of this command returns to the default.

Parameters 
username—
Specifies the user name of this host.
no-domain—
No username is specified.
domain-only—
Only the domain part of the username is specified, for example, nokia.com.

snooping

Syntax 
[no] snooping
Context 
config>service>ies>sub-if>grp-if>ipv6>dhcp6
config>service>vprn>sub-if>grp-if>ipv6>dhcp6
Description 

This command enables the group-interface to snoop DHCPv6 relay messages exchange between the subscriber host and the DHCPv6 server. A successful DHCPv6 address assignment will trigger ESM DHCPv6 host creation and a release of the lease will trigger host deletion. This feature is for ESMv6 applications where a Layer 3 aggregation network is upstream from the BNG.

The no form of this command reverts to the default.

user-ident

Syntax 
user-ident user-ident
no user-ident
Context 
config>service>ies>sub-if>grp-if>ipv6>dhcp6
config>service>vprn>sub-if>grp-if>ipv6>dhcp6
Description 

This feature is only applicable when DHCPv6-snooping is enabled. The Ethernet header MAC address on DHCPv6 is used as the default key host identification. This command allows addition the keys for identifying the DHCPv6 host. The interface-id can be included in addition to the MAC key to further differentiate each DHCPv6 host.

The no form of this command reverts to the default.

Default 

user-ident mac

Parameters 
user-ident—
Specifies the DHCP6 user-identification for this interface.
Values—
mac — Specifies to use only the Ethernet MAC of the DHCPv6 message to identify the host.
mac-interface-id — Specifies to additionally use the interface-id to identify the DHCPv6 host.

 

interface

Syntax 
interface ip-int-name service-id service-id
no interface
Context 
config>subscr-mgmt>loc-user-db>ipoe>host
Description 

This command specifies the interface where IPoE sessions are terminated.

The no version of this command disables the parameter.

Parameters 
ip-int-name—
Specifies the name of the group interface
service-id—
Specifies the service ID or name where the group interface resides
Values—
service-id — 1 to 2147483647
service-name — up to 64 characters

 

ipv6-address

Syntax 
ipv6-address ipv6-address
no ipv6-address
Context 
config>subscr-mgmt>loc-user-db>ipoe>host
config>subscr-mgmt>loc-user-db>ppp>host
Description 

This command configures static DHCPv6 IA-NA address for the host. This address is delegated to the client as /128 via DHCPv6 proxy function within the router. This IP address must not be part of any DHCP pool within internal DHCP server.

The no form of this command removes the IPv6 address from the host configuration.

Parameters 
ipv6-address—
Specifies the IPv6 address.
Values—

ipv6-address:

ipv6-prefix x:x:x:x:x:x:x:x (eight 16-bit pieces)

x:x:x:x:x:x:d.d.d.d

x [0 to FFFF]H

d [0 to 255]D

 

ipv6-delegated-prefix

Syntax 
ipv6-delegated-prefix ipv6-prefix/prefix-length
no ipv6-delegated-prefix
Context 
config>subscr-mgmt>loc-user-db>ipoe>host
config>subscr-mgmt>loc-user-db>ppp>host
Description 

This command configures static DHCPv6 IA-PD prefix for the host. This prefix can be further delegated by the host itself to its clients. The prefix length is restricted to 48 to 64 bits. This prefix must not be part of any DHCP pool within internal DHCP server.

Parameters 
ipv6-address—
Specifies the IPv6 address.
Values—

ipv6-address:

ipv6-prefix x:x:x:x:x:x:x:x (eight 16-bit pieces)

x:x:x:x:x:x:d.d.d.d

x [0 to FFFF]H

d [0 to 255]D

prefix-length

[48 to 64]

 

ipv6-delegated-prefix-length

Syntax 
ipv6-delegated-prefix-length bits
no ipv6-delegated-prefix-length
Context 
config>subscr-mgmt>loc-user-db>ipoe>host
config>subscr-mgmt>loc-user-db>ppp>host
Description 

This command allows configuration of delegated prefix length via local user database.

The no form of this command reverts to the default.

Parameters 
bits—
Specifies the delegated prefix length in bits.
Values—
48 to 64

 

ipv6-delegated-prefix-pool

Syntax 
ipv6-delegated-prefix-pool pool-name
no ipv6-delegated-prefix-pool
Context 
config>subscr-mgmt>loc-user-db>ipoe>host
config>subscr-mgmt>loc-user-db>ppp>host
Description 

This command configures the pool name that will be used in DHCPv6 server for DHCPv6 IA-PD prefix selection.

The no form of this command removes the pool name from the configuration.

Parameters 
pool-name—
Specifies the pool name to be assigned to the delegated prefix pool.

ipv6-lease-times

Syntax 
[no] ipv6-lease-times
Context 
config>subscr-mgmt>loc-user-db>ipoe>host
config>subscr-mgmt>loc-user-db>ppp>host
Description 

This command enables the context to configure lease times for DHCPv6.

preferred-lifetime

Syntax 
preferred-lifetime [days days] [hrs hours] [min minutes] [sec seconds]
preferred-lifetime infinite
no preferred-lifetime
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>ipv6-lease-times
Description 

This command specifies the preferred lifetime for the lease times. When the preferred lifetime expires, then any derived addresses are deprecated.

The no form of this command reverts to the default.

Parameters 
infinite—
Specifies that the valid lifetime is infinite.
preferred-lifetime—
Specifies the preferred lifetime.
Values—

days days

0 to 3650

hrs hours

0 to 23

min minutes

0 to 59

sec seconds

0 to 59

 

rebind-timer

Syntax 
rebind-timer [days days] [hrs hours] [min minutes] [sec seconds]
no rebind-timer
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>ipv6-lease-times
config>subscr-mgmt>loc-user-db>ppp>host>ipv6-lease-times
config>service>ies>sub-if>grp-if>ipv6>dhcp6>proxy
config>service>vprn>sub-if>grp-if>ipv6>dhcp6>proxy
config>router>dhcp6>server>pool>prefix
config>service>vprn>dhcp6>server>pool>prefix
Description 

This command configures the lease rebind timer (T2) via LUDB.

The T2 time is the time at which the client contacts any available addressing authority to extend the lifetimes of DHCPv6 leases. T2 is a time duration relative to the current time expressed in units of seconds.

The IP addressing authority controls the time at which the client contacts the addressing authority to extend the lifetimes on assigned addresses/prefixes through the T1 and T2 parameters assigned to an IA. At time T1 for an IA, the client initiates a Renew/Reply message exchange to extend the lifetimes on any addresses in the IA. The client includes an IA option with all addresses/prefixes currently assigned to the IA in its Renew message. Recommended values for T1 and T2 are .5 and .8 times the shortest preferred lifetime of the addresses/prefixes in the IA that the addressing authority is willing to extend, respectively.

The configured rebind timer should always be longer than or equal to the renew timer.

The T1 and T2 are carried in the IPv6 address option that is within the IA.

The no form of this command reverts to the default.

Default 

rebind-timer min 48

Parameters 
rebind-timer—
Specifies the preferred lifetime.
Values—

days days

0 to 14

hrs hours

0 to 23

min minutes

0 to 59

sec seconds

0 to 9

 

renew-timer

Syntax 
renew-timer [days days] [hrs hours] [min minutes] [sec seconds]
no renew-timer
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>ipv6-lease-times
config>subscr-mgmt>loc-user-db>ppp>host>ipv6-lease-times
config>service>ies>sub-if>grp-if>ipv6>dhcp6>proxy
config>service>vprn>sub-if>grp-if>ipv6>dhcp6>proxy
config>router>dhcp6>server>pool>prefix
config>service>vprn>dhcp6>server>pool>prefix
Description 

This command configures the lease renew time (T1) via LUDB.

The T1 is the time at which the client contacts the addressing authority to extend the lifetimes of the DHCPv6 leases (addresses or prefixes). T1 is a time duration relative to the current time expressed in units of seconds.

The IP addressing authority controls the time at which the client contacts the addressing authority to extend the lifetimes on assigned addresses through the T1 and T2 parameters assigned to an IA. At time T1 for an IA, the client initiates a Renew/Reply message exchange to extend the lifetimes on any addresses in the IA. The client includes an IA option with all addresses currently assigned to the IA in its Renew message. Recommended values for T1 and T2 are .5 and .8 times the shortest preferred lifetime of the addresses in the IA that the addressing authority is willing to extend, respectively.

The configured renew timer should always be smaller than or equal to the rebind timer.

The T1 and T2 are carried in the IPv6 address option that is within the IA.

The no form of this command reverts to the default.

Default 

renew-timer min 30

Parameters 
renew-timer—
Specifies the preferred lifetime.
Values—

days days

0 to 7

hrs hours

0 to 23

min minutes

0 to 59

sec seconds

0 to 59

 

valid-lifetime

Syntax 
valid-lifetime [valid-lifetime]
valid-lifetime infinite
no valid-lifetime
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>ipv6-lease-times
config>subscr-mgmt>loc-user-db>ppp>host>ipv6-lease-times
config>service>ies>sub-if>grp-if>ipv6>dhcp6>proxy
config>service>vprn>sub-if>grp-if>ipv6>dhcp6>proxy
Description 

This command configured valid-lifetime for DHCPv6 lease (address/prefix).

The valid lifetime is the length of time an address/prefix remains in the valid state (for example., the time until invalidation). The valid lifetime must be greater than or equal to the preferred lifetime. When the valid lifetime expires, the address/prefix becomes invalid and must not be used in communications. RFC 2461, sec 6.2.1 recommends default value of 30 days.

Each address/prefix assigned to the client has associated preferred and valid lifetimes specified by the address assignment authority (DHCP server, RADIUS, ESM). To request an extension of the lifetimes assigned to an address, the client sends a Renew message to the addressing authority. The addressing authority sends a Reply message to the client with the new lifetimes, allowing the client to continue to use the address/prefix without interruption.

The lifetimes are transmitted from the addressing authority to the client in the IA option on the top level (not the address or prefix level).

The no form of this command reverts to the default.

Default 

valid-lifetime days 1

Parameters 
infinite—
Specifies that the valid lifetime is infinite.
Values—
0xffffffff

 

valid-lifetime—
Specifies the preferred lifetime.
Values—

days days

0 to 3650

hrs hours

0 to 23

min minutes

0 to 59

sec seconds

0 to 9

 

ipv6-slaac-prefix

Syntax 
ipv6-slaac-prefix ipv6-prefix/prefix-length
no ipv6-slaac-prefix
Context 
config>subscr-mgmt>loc-user-db>ppp>host
config>subscr-mgmt>loc-user-db>ipoe>host
Description 

This command configures static IPv6 SLAAC prefix (PIO) for the host. The host will assign an IPv6 address to itself based on this prefix. The prefix length is 64 bits.

The no form of this command removes the static IPv6 SLAAC prefix (PIO) for the host from the configuration.

Default 

no ipv6-slaac-prefix

Parameters 
ipv6-prefix/prefix-length—
Specifies the IPv6 address and prefix length.
Values—

<ipv6-prefix/prefi*> : ipv6-prefix x:x:x:x:x:x:x:x (eight 16-bit pieces)

x:x:x:x:x:x:d.d.d.d

x [0 to FFFF]H

d [0 to 255]D

prefix-length

64

 

ipv6-slaac-prefix-pool

Syntax 
ipv6-slaac-prefix-pool pool
no ipv6-slaac-prefix-pool
Context 
config>subscr-mgmt>loc-user-db>ipoe>host
config>subscr-mgmt>loc-user-db>ppp>host
Description 

This command configures the IPv6 SLAAC prefix pool of this host.

The no form of this command reverts to the default.

ipv6-wan-address-pool

Syntax 
ipv6-wan-address-pool pool-name
no ipv6-wan-address-pool
Context 
config>subscr-mgmt>loc-user-db>ipoe>host
config>subscr-mgmt>loc-user-db>ppp>host
Description 

This command configures the pool name that will be used in DHCPv6 server for DHCPv6 IA-PA address selection.

The no form of this command removes the pool name from the configuration.

Parameters 
pool-name—
Specifies the WAN address pool, up to 32 characters.

link-address

Syntax 
link-address ipv6-address
no link-address
Context 
config>subscr-mgmt>loc-user-db>ipoe>host
config>service>ies>if>ipv6>dhcp6-relay
config>service>ies>sub-if>ipv6>dhcp6>relay
config>service>ies>sub-if>grp-if>ipv6>dhcp6>relay
config>service>vprn>if>ipv6>dhcp6-relay
config>service>vprn>sub-if>ipv6>dhcp6>relay
config>service>vprn>sub-if>grp-if>ipv6>dhcp6>relay
Description 

This command configures the link address used for prefix selection at the DHCP server.

The link-address is a field in DHCP6 Relay-Forward message that is used in DHCP6 server to select the IPv6 address (IA-NA) or IPv6 prefix (IA-PD) from a pool with configured prefix range covering the link-address. The selection scope is the pool or a prefix range within the pool.

The no form of this command reverts to the default.

Parameters 
ipv6-address—
Specifies the link-address
Values—

<ipv6-address>

ipv6-address - x:x:x:x:x:x:x:x (eight 16-bit pieces)

x:x:x:x:x:x:d.d.d.d

x - [0 to FFFF]H

d - [0 to 255]D

 

server

Syntax 
server ip-address
no server
Context 
config>service>vprn>sub-if>grp-if>ipv6>dhcp6>relay
Description 

This command configures the IPv6 address of the DHCP6 server to relay to.

The configured DHCP6 server IPv6 address must reference one of the addresses configured under the DHCP6 CLI context of an IES/VPRN subscriber or group interface.

The no form of this command reverts to the default.

Parameters 
ip-address—
Specifies up to eight IPv6 addresses of the DHCP6 server

match-radius-proxy-cache

Syntax 
match-radius-proxy-cache
Context 
config>subscr-mgmt>loc-user-db>ipoe>host
Description 

This command enables the context to configure RADIUS proxy cache match parameters.

fail-action

Syntax 
fail-action {continue | drop}
no fail-action
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>match-radprox-cache
Description 

This command specifies the action to take when no match is found in the cache.

The no form of this command reverts to the default.

Default 

fail-action drop

Parameters 
continue—
Specifies to continue when no match is found
drop—
Specifies to drop when no match is found

mac-format

Syntax 
mac-format mac-format
no mac-format
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>match-radprox-cache
Description 

This command specifies how a MAC address is represented.

Default 

mac-format “aa:”

Parameters 
mac-format—
Specifies the expected MAC address format

match

Syntax 
match {circuit-id | mac | remote-id}
match option [number] [option6 [number]
match option6 [number]
no match
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>match-radprox-cache
Description 

This command specifies in what DHCPv6 option to retrieve the value to be used as lookup key in the RADIUS proxy cache.

The no form of this command reverts to the default.

Default 

match mac

Parameters 
circuit-id—
Specifies to use the circuit Id to match against.
mac—
Specifies the MAC address to match against.
remote-id—
Specifies the remote ID to match against.
option number—
Specifies the option number that the DHCP server uses to send the identification strings to the client.
Values—
1 to 124

 

option6 number—
Specifies the DHCPv6 option to retrieve the value to be used as lookup key in the RADIUS proxy cache.
Values—
1 to 65535

 

server

Syntax 
server [service service-id] name server-name]
no server
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>match-radprox-cache
Description 

This command specifies the RADIUS proxy server.

The no form of this command reverts to the default.

Parameters 
service-id—
Specifies an existing service ID or service name.
Values—
service-id - 1 to 214748364
service-name - up to 64 characters.

 

server-name —
Specifies the name of local user database server, up to 32 characters.

mld-parameters

Syntax 
mld-parameters
Context 
config>subscr-mgmt>loc-user-db>ppp>host
config>subscr-mgmt>loc-user-db>ipoe>host
Description 

This command enables the context to configure an MLD import policy.

import

Syntax 
import policy-name
no import
Context 
config>subscr-mgmt>loc-user-db>ppp>host>mld-parameters
config>subscr-mgmt>loc-user-db>ipoe>host>mld-parameters
Description 

This command configures an MLD import policy.

The LUDB allows a list of up to 14 MLD import policies per host. The MLD policy also allows the configuration of an additional import policy, providing a total of 15 MLD import policies per host. The import policy inside the MLD policy is always applied last, which determines if the list is a black list or a white list. To configure an MLD white list, the import policies in the LUDB should all be allowed or forward entries and the import policy in the MLD policy should have a default action to deny all. To configure a black list, the import policies inside the LUDB should drop entries and the MLD policy import policy default action should be to forward all. The 15 import policies can be configured to be a mixed white and black list. Since it is difficult to control the order of the import policies within the LUDB, it is recommended to provision the import policy inside the MLD policy first for deterministic behavior.

The no form of this command removes the specified import policy.

Parameters 
policy-name —
Specifies the MLD import policy used to control the multicast group accessible for the subscriber host.

msap-defaults

Syntax 
msap-default
Context 
config>subscr-mgmt>loc-user-db>ipoe>host
config>subscr-mgmt>loc-user-db>ppp>host
Description 

This command configures MSAP authentication defaults.

group-interface

Syntax 
group-interface ip-int-name [prefix {port-id}] [suffix {port-id}]
no group-interface
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>msap-defaults
config>subscr-mgmt>loc-user-db>ppp>host>msap-defaults
Description 

This command configures the group interface.

The no form of this command removes the group interface parameters from the configuration.

Parameters 
ip-int-name—
Specifies the IP interface name, up to 32 characters
port-id—
Specifies the port ID as the prefix to the specified IP interface name
port-id—
Specifies the port ID as the suffix to the specified IP interface name

msap-policy

Syntax 
msap-policy msap-policy-name
no policy
Context 
config>subscr-mgmt
config>subscr-mgmt>loc-user-db>ipoe>host>msap-defaults
config>subscr-mgmt>loc-user-db>ppp>host>msap-defaults
Description 

This command configures the MSAP policy.

The no form of this command removes the MSAP policy name from the configuration.

Parameters 
msap-policy-name—
Specifies the policy name, up to 32 characters.

service

Syntax 
service service-id
no service
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>msap-defaults
config>subscr-mgmt>loc-user-db>ppp>host>msap-defaults
Description 

This command sets default service for all subscribers created based on trigger packets received on the given capture SAP in case the corresponding VSA is not included in the RADIUS authentication response. This command is applicable to capture SAP only.

The no form of this command reverts to the default.

Parameters 
service-id—
Specifies the service ID as an integer or the service name.
Values—
service-id - 1 to 2147483648
service-name - up to 64 characters

 

dns-server

Syntax 
dns-server ip-address [ip-address]
dns-server ipv6-address [ipv6-address]
no dns-server
Context 
config>router>dhcp>server>pool>options
config>router>dhcp6>server>defaults>options
config>subscr-mgmt>loc-user-db>ipoe>host>options
config>subscr-mgmt>loc-user-db>ppp>host>options
config>service>vprn>dhcp>server>pool>options
Description 

This command configures the IPv6 address of the DNS server.

The no form of this command removes the IPv6 address from the DNS server configuration.

Parameters 
ip-address—
Specifies up to four DNS server IP addresses. Each address must be unique within the subnet and specified in dotted decimal notation. Allowed values are IP addresses in the range 1.0.0.0 – 223.255.255.255 (with support of /31 subnets).
ipv6-address—
Specifies up to four DNS server IPv6 addresses for DHCP6 configurations. Each address must be unique within the subnet and specified in dotted decimal notation. Allowed values are IP addresses in the range 1.0.0.0 – 223.255.255.255 (with support of /31 subnets).

domain-name

Syntax 
domain-name domain-name
no domain-name
Context 
config>router>dhcp>server>pool>options
config>subscr-mgmt>loc-user-db>ipoe>host>options
config>router>dhcp6>server>defaults>options
config>router>dhcp6>server>pool>options
config>router>dhcp6>server>pool>prefix>options
config>service>vprn>dhcp>server>pool>options
config>service>vprn>dhcp6>server>pool>options
config>service>vprn>dhcp6>server>pool>prefix>options
Description 

This command configures the default domain for a DHCP client that the router uses to complete unqualified host names (without a dotted-decimal domain name).

The no form of this command removes the name from the configuration.

Parameters 
domain-name—
Specifies the domain name for the client, up to 127 characters.

options6

Syntax 
options6
Context 
config>subscr-mgmt>loc-user-db>ppp>host
config>subscr-mgmt>loc-user-db>ipoe>host
Description 

This command enables the context to configure IPv6 DNS server information in the local user database

dns-server

Syntax 
dns-server ipv6-address [ipv6-address]
no dns-server
Context 
config>router>dhcp6>server>pool>options
config>router>dhcp6>server>pool>prefix>options
config>subscr-mgmt>loc-user-db>ppp>host>options6
config>subscr-mgmt>loc-user-db>ipoe>host>options6
config>service>vprn>dhcp6>server>pool>prefix>options
Description 

This command configures IPv6 DNS server addresses that can be used for name resolution

The no form of this command removes the IPv6 address from the dns-server configuration.

Parameters 
ipv6-address—
Specifies IPv6 DNS server addresses.

retail-service-id

Syntax 
retail-service-id service-id
no retail-service-id
Context 
config>subscr-mgmt>loc-user-db>ipoe>host
config>subscr-mgmt>loc-user-db>ppp>host
Description 

This command indicates the service ID of the retailer VPRN service to which this session belongs. If the value of this object is non-zero, the session belongs to a retailer VPRN.

The no form of this command removes the service ID from the configuration.

Parameters 
service-id—
Specifies the retailer service ID or name.
Values—

service-id:

1 to 2147483647

service-name:

Service name up to 64 characters.

 

retail-service-id

Syntax 
[no] retail-service-id service-id
Context 
config>subscr-mgmt>loc-user-db>ipoe>host
config>subscr-mgmt>loc-user-db>ppp>host
Description 

This command sets the retail-service ID for a given subscriber host.

The no form of this command reverts to the default.

Parameters 
service-id—
Specifies the service ID as an integer or service name, up to 64 characters.
Values—
1 to 2147483647, svc-name

 

rip-policy

Syntax 
rip-policy policy-name
no rip-policy
Context 
config>subscr-mgmt>loc-user-db>ipoe>host
config>subscr-mgmt>loc-user-db>ppp>host
Description 

This command configures the RIP policy name. This policy is applied to a subscriber IPv4 host to enable the BNG to learn RIP routes from the host. RIP routes are never sent to the hosts.

The no form of this command removes the RIP policy name from the configuration

Parameters 
policy-name—
Specifies the RIP policy name up to 32 characters.

router-advertisement-policy

Syntax 
router-advertisement-policy policy
no router-advertisement-policy
Context 
config>subscr-mgmt>loc-user-db>ipoe>host
config>subscr-mgmt>loc-user-db>ppp>host
Description 

This command applies an RA policy to the host.

The no form of this command removes the policy from the configuration.

Parameters 
policy—
Specifies the policy name, up to 32 characters.

server6

Syntax 
server6 ipv6-address
no server6
Context 
config>subscr-mgmt>loc-user-db>ipoe>host
Description 

This command allows DHCP6 server selection based on the host entry in LUDB.

The configured DHCP6 server IP address must reference one of the v6 addressees configured under the config>service>vprn>sub-if>grp-if>ipv6>dhcpv6>relay or config>service>ies>sub-if>grp-if>ipv6>dhcpv6>relay context.

The no form of this command reverts to the default.

Parameters 
ipv6-address—
Specifies the retailer service ID.
Values—

ipv6-address

ipv6-address - x:x:x:x:x:x:x:x (eight 16-bit pieces)

x:x:x:x:x:x:d.d.d.d

x - [0 to FFFF]H

d - [0 to 255]D

 

to-client-options

Syntax 
to-client-options
Context 
config>subscr-mgmt>loc-user-db>ipoe>host
config>subscr-mgmt>loc-user-db>ppp>host
Description 

This command enables the context to configure DHCP options to send to the client.

option

Syntax 
option option-number address ipv4-address [ipv4-address]
option option-number hex hex-string
option option-number string ascii-string
no option option-number
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>to-client-options>ipv4
config>subscr-mgmt>loc-user-db>ppp>host>to-client-options>ipv4
Description 

This command configures DHCPv4 options via LUDB that are passed in all DHCP messages to the client. The options are blindly appended to any options already present in the DHCP message. In other words, there is no intelligent merging of the options where overlapping options from different sources are further evaluated to determine whether only one option or multiple options should be returned to the client.

Multiple DHCP options can be configured at the same time although each option requires its own option statement. Those options are equivalent to RADIUS VSAs Alc-ToCLient-Dhcp4-Options.

DHCPv4 options can be provided via DHCPv4 server in the relay case. In addition, DHCPv4 options provided via LUDB or RADIUS can be supplied and consequently appended to the already existing options. If DHCPv4 options are provided simultaneously via LUDB and RADIUS, the RADIUS as a source of DHCPv4 option is blocked and the options supplied via LUDB are passed to the client. This is valid for the relay and proxy case.

Any DHCP option may be encoded in the option statement. An example of the option statement for DHCPv4 default-gateway is given below:

option 3 192.168.1.254

DHCPv4 options may be fixed length or variable length. They are appended at the end of DHCPv4 messages. All options begin with a tag octet, which uniquely identifies the option. Fixed-length options without data consist of only a tag octet. Only options 0 and 255 are fixed length. All other options are variable-length.

The no form of the removes the option from the configuration.

Parameters 
option-number—
Specifies up to four option numbers. This can be a well-known or an anonymous option.
ipv4-address —
Specifies an IPv4 address as an option.
hex-string—
Specifies options coded as Hex characters.
ascii-string—
Specifies options coded as an ASCII string.

to-server-options

Syntax 
[no] to-server-options
Context 
config>subscr-mgmt>loc-user-db>ipoe>host
Description 

This command enables the context to configure DHCP options to send to the server

option

Syntax 
option option-number address [ip-address]
no option option-number
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>to-server-options>ipv6
Description 

This command specifies the DHCPv6 options to send to the server. There are four options:

  1. option option-number hex hex-string
  1. option option-number string ascii-string
  1. option option-number domain domain-name
  1. no option option-number

The no form of this command removes the option parameters from the configuration.

Parameters 
option-number—
Specifies the option number and the identification string that will inserted in the DHCP client message to the server.
Values—
1 to 65535

 

ip-address—
Specifies the IPv6 address.
hex-string—
Specifies the hex value of the option.
Values—
0x0 to 0xFFFFFFFF (maximum 254 hex nibbles)

 

ascii-string—
Specifies the string value of the option.
Values—
127 character max

 

domain-name—
Specifies the domain as in RFC 1035, Domain Names - Implementation and Specification, section 3.1.

wpp

Syntax 
wpp
Context 
config>subscr-mgmt>loc-user-db>ipoe>host
Description 

This command enables the context to configure WPP parameters.

initial-app-profile

Syntax 
initial-app-profile app-profile-name
no initial-app-profile
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>wpp
config>service>ies>sub-if>grp-if>wpp
config>service>vprn>sub-if>grp-if>wpp
Description 

This command specifies the initial app-profile for the hosts created on the group-interface. This initial app-profile is replaced after hosts pass web portal authentication.

The no form of this command reverts to the default.

Parameters 
app-profile-name—
Specifies the initial application profile, up to 32 characters, to be used during the WPP authentication phase of the IPoE hosts.

initial-sla-profile

Syntax 
initial-sla-profile sla-profile-name
no initial-sla-profile
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>wpp
config>service>ies>sub-if>grp-if>wpp
config>service>vprn>sub-if>grp-if>wpp
Description 

This command specifies the initial sla-profile for the hosts created on the group-interface. This initial sla-profile is replaced after hosts pass web portal authentication.

The no form of this command reverts to the default.

Parameters 
sla-profile-name—
Specifies the initial SLA profile, up to 32 characters, to be used during the WPP authentication phase of the IPOE host.

initial-sub-profile

Syntax 
initial-sub-profile sub-profile-name
no initial-sub-profile
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>wpp
config>service>ies>sub-if>grp-if>wpp
config>service>vprn>sub-if>grp-if>wpp
Description 

This command specifies the initial sub-profile for the hosts created on the group-interface. This initial sub-profile is replaced after hosts pass web portal authentication.

The no form of this command reverts to the default.

Parameters 
sub-profile-name—
Specifies the initial subscriber profile, up to 32 characters, to be used during the WPP authentication phase of the IPoE host.

portal

Syntax 
[no] portal router router-instance name wpp-portal-name
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>wpp
Description 

This command configures the portal for the portal group. This command is mutually exclusive with the portal-group command.

Parameters 
router-instance—
Specifies the virtual router instance.
Values—

router-name:

Base, management

service-id:

1 to 2147483647

service-name:

Specifies the service name, up to 64 characters

 

Default—
Base
wpp-portal-name—
Specifies the name of the web portal server, up to 32 characters.

portal-group

Syntax 
portal-group portal-group-name
no portal-group
Context 
config>subscr-mgmt>loc-user-db>ipoe>host>wpp
Description 

This command configures the WPP portal group name. This command is mutually exclusive with the portal command.

Parameters 
portal-group-name—
Specifies the WPP portal group name, up to 32 characters.

restore-disconnected

Syntax 
[no] restore-disconnected
Context 
config>service>ies>sub-if>grp-if>wpp
config>service>vprn>sub-if>grp-if>wpp
Description 

This command specifies that the initial profiles must be restored after a DHCP host has disconnected. The behavior that system will restore the initial-sla-profile, initial-sub-profile, or initial-app-profile when hosts disconnects instead of removing them.

The no form of this command specifies that the initial profiles will not be restored after a DHCP host has disconnected.

Default 

restore-disconnected

mask

Syntax 
mask type match-type {[prefix-string prefix-string | prefix-length prefix-length] [suffix-string suffix-string | suffix-length suffix-length]}
no mask type match-type
mask type dhcp-match-type {[prefix-string prefix-string | prefix-length prefix-length] [suffix-string suffix-string | suffix-length suffix-length]}
no mask type dhcp-match-type
Context 
config>subscr-mgmt>loc-user-db>ppp
config>subscr-mgmt>loc-user-db>ipoe
Description 

This command configures the mask.

The no form of this command removes the mask parameters from the configuration.

Parameters 
ppp-match-type—
Specifies the sub-option inserted by the PPPoE intermediate agent.
Values—
circuit-id, remote-id, sap-id, service-name, username

 

dhcp-match-type—
The data type represents the type of matching done to identify a DHCP host.
Values—
circuit-id, option60, remote-id, sap-id, string, system-id

 

prefix-string—
Specifies a substring that is stripped of the start of the incoming circuit ID before it is matched against the value configured in the DHCP or PPPoE circuit ID.

This string can only contain printable ASCII characters. The “*” character is a wildcard that matches any substring. If a "\" character is masked, use the escape key so it becomes "\\".

Values—
127 characters maximum, “*”

 

prefix-length—
Specifies the number of characters to remove from the start of the incoming circuit ID before it is matched against the value configured in the circuit ID
Values—
1 to 127

 

suffix-string—
Specifies a substring that is stripped of the end of the incoming circuit ID before it is matched against the value configured in circuit ID.

This string can only contain printable ASCII characters. The “*” character is a wildcard that matches any substring. If a "\" character is masked, use the escape key so it becomes "\\".

Values—
127 characters maximum

 

suffix-length—
Specifies the number of characters to remove from the end of the incoming circuit ID before it is matched against the value configured in the circuit ID.
Values—
1 to 127

 

user-db

Syntax 
user-db local-user-db-name
no user-db
Context 
config>subscr-mgmt>loc-user-db>ppp>host
Description 

This command specifies local user database for PPP PAP/CHAP access.

With this configuration, system will access the specified DB again during PPP PAP/CHAP phase.

This configuration only becomes effective when system is accessing parent DB during PPPoE discovery phase.

The no form of this command removes the name from the configuration.

Parameters 
local-user-db-name—
Specifies the name of the local user database for PAP/CHAP access

match-list

Syntax 
match-list match-type-1 [match-type-2]
no match-list
Context 
config>subscr-mgmt>loc-user-db>ppp
config>subscr-mgmt>loc-user-db>ipoe
Description 

This command specifies the type of matching done to identify a host. There are different match-types for PPPoE or IPoE hosts of which a maximum of four can be specified.

The no form of this command reverts to the default.

Parameters 
match-type-x—
Specifies up to four matching types to identify a host.
Values—
For IPoE: circuit-id, derived-id, dual-stack-remote-id, encap-tag-range, ip, mac, option60, remote-id, sap-id, service-id, string, system-id

 

Values—
For PPP: circuit-id, derived-id, remote-id, mac, sap-id, service-id, encap-tag-range, service-name, username

 

Note:

The format of remote-id in IPv6 is different that the format of remote-id in IPv4; IPv6 remote-id contains enterprise-id filed that is also honored in matching.

dual-stack-remote-id — Specifies the enterprise-id in v6 Remote-id will be stripped off before LUDB matching is performed. Processing of IPv4 Remote-id remains unchanged. This will allow a single host entry in LUDB for dual-stack host where host identification is performed based on the Remote-id field.

sap-id — Specifies the SAP ID on which DHCPv4 packet are received. The sap-id is inserted as ALU VSO (82,9,4) by the DHCPv4 relay in router. This is enabled via configuration under the vendor-specific-option CLI hierarchy of the DHCPv4 relay. Since the dhcp-relay configuration is enabled under the group-interface CLI hierarchy, the group-interface and the service-id must be known before the sap-id can be used for LUDB match.

encap-tag-range — Specifies the VLAN tags.

ip — Specifies the source IPv4/IPv6 address of a data-trigger packet.

service-id — Specifies the service-id of the ingress SAP for DHCPv4 packets. The service-id is inserted as ALU VSO (82,9,3) by the DHCPv4 relay in router. This is enabled via configuration under the vendor-specific-option CLI hierarchy of the DHCPv4 relay.

string — Specifies the custom string configured under the vendor-specific-option CLI hierarchy of the DHCPv4 relay. The string is inserted as ALU VSO (82,9,5) by the DHCPv4 relay in router. Since the dhcp-relay configuration is enabled under the group-interface CLI hierarchy, the group-interface and the service-id must be known before the string can be used for LUDB match.

system-id — Specifies the system-id of the node name configured under the system>name CLI hierarchy. The system-id is inserted as ALU VSO (82,9,1) by the DHCPv4 relay in router. This is enabled via configuration under the vendor-specific-option CLI hierarchy of the DHCPv4 relay. Since the dhcp-relay configuration is enabled under the group-interface CLI hierarchy, the group-interface and the service-id must be known before the system-id can be used for LUDB match.

derived-id — Specifies the value extracted by Python script during processing of DHCP Discover/Solicit/Request/Renew/Rebind Messages (client to server bound messages). The value is stored in the DHCP Transaction Cache (DTC) in a variable named alc.dtc.derivedId. This value has a lifespan of a DHCP transaction (a single pair of messages exchanged between the client and the server, for example DHCP Discover and DHCP Offer).

ppp

Syntax 
ppp
Context 
config>subscr-mgmt>loc-user-db
Description 

This command enables the context to configure PPP host parameters.

access-loop-encapsulation

Syntax 
[no] access-loop-encapsulation
Context 
config>subscr-mgmt>loc-user-db>ppp>host
Description 

This command enables the context to configure access loop information.

encap-offset

Syntax 
encap-offset [type type]
no encap-offset
Context 
config>subscr-mgmt>loc-user-db>ppp>host>ali
Description 

This command configures the egress encapsulation offset.

The no form of this command reverts to the default.

Parameters 
type—
Selects the encapsulation type
Values—
pppoa-llc, pppoa-null, pppoeoa-llc, pppoeoa-llc-fcs, pppoeoa-llc-tagged, pppoeoa-llc-tagged-fcs, pppoeoa-null, pppoeoa-null-fcs, pppoeoa-null-tagged, pppoeoa-null-tagged-fcs, ipoa-llc, ipoa-null, ipoeoa-llc, ipoeoa-llc-fcs, ipoeoa-llc-tagged, ipoeoa-llc-tagged-fcs, ipoeoa-null, ipoeoa-null-fcs, ipoeoa-null-tagged, ipoeoa-null-tagged-fcs, pppoe, pppoe-tagged, ipoe, ipoe-tagged

 

rate-down

Syntax 
rate-down rate
no rate-down
Context 
config>subscr-mgmt>loc-user-db>ppp>host>ale
Description 

This command configures the last mile link downstream rate in the access loop.

The no form of this command reverts to the default.

Parameters 
rate—
Specifies the last mile link downstream rate needed for proper (shaping) rate calculations and interleaving delay in the access loop.
Values—
1 to 100000 kb/s

 

access-loop-information

Syntax 
access-loop-information
Context 
config>subscr-mgmt>loc-user-db>ppp>host
Description 

This command enables the context to configure access loop information in the local user database.

circuit-id

Syntax 
circuit-id sap-id
circuit-id string ASCII string
no circuit-id
Context 
config>subscr-mgmt>loc-user-db>ppp>host>ali
Description 

This command specifies a circuit-id for PPPoE hosts. A circuit ID received in PPPoE tags has precedence over the LUDB specified circuit ID.

The no form of this command reverts to the default.

Parameters 
sap-id—
Specifies to use the SAP ID of the PPPoE session as the circuit ID.
ASCII string—
Specifies the circuit ID as a string, up to 63 characters.

remote-id

Syntax 
remote-id mac
remote-id string ASCII string
no remote-id
Context 
config>subscr-mgmt>loc-user-db>ppp>host>ali
Description 

This command specifies a remote-id for PPPoE hosts. A remote-id received in PPPoE tags has precedence over the LUDB specified remote ID.

The no form of this command reverts to the default.

Parameters 
mac—
Specifies MAC address of the PPPoE session as the remote ID.
ASCII string—
Specifies the circuit ID as a string, up to 63 characters.

force-ipv6cp

Syntax 
[no] force-ipv6cp
Context 
config>subscr-mgmt>loc-user-db>ppp>host
Description 

This command specifies if the IPv6 control protocol should be negotiated after PPP reaches the Network-Layer Protocol phase.

The no form of this command reverts to the default.

l2tp

Syntax 
l2tp
Context 
config>subscr-mgmt>loc-user-db>ppp>host
Description 

This command enables the context to configure L2TP parameters for the host.

group

Syntax 
group tunnel-group-name [service-id service-id]
no group
Context 
config>subscr-mgmt>loc-user-db>ppp>host>l2tp
Description 

This command configures the L2TP tunnel group. The tunnel-group-name is configured in the config>router>l2tp context. Refer to the 7450 ESS, 7750 SR, 7950 XRS, and VSR Router Configuration Guide.

Parameters 
tunnel-group-name—
Specifies an existing tunnel L2TP group, up to 63 characters.
service-id service-id—
Specifies an existing service ID or service name.
Values—
service-id: 1 to 214748364
service-name: A string, up to 64 characters

 

authentication-policy

Syntax 
authentication-policy policy-name
no authentication-policy
Context 
config>subscr-mgmt>loc-user-db>ppp>host
Description 

This command configures the authentication policy for the host. A host name with name “default” will be matched when all other hosts do not match.

padi-auth-policy

Syntax 
padi-auth-policy policy-name
no padi-auth-policy
Context 
config>subscr-mgmt>loc-user-db>ppp>host
Description 

This command configures the PADI authentication policy of this host.

Parameters 
policy-name—
Specifies the authentication policy name.

pado-delay

Syntax 
pado-delay deci-seconds
no pado-delay
Context 
config>subscr-mgmt>loc-user-db>ppp>host
Description 

This command configures the delay timeout before sending a PPPoE Active Discovery Offer (PADO).

Parameters 
deci-seconds—
Specifies the delay timeout before sending a PADO.
Values—
1 to 30

 

password

Syntax 
password {ignore | chap string |pap string} [hash | hash2 | custom]
no password
Context 
config>subscr-mgmt>loc-user-db>ppp>host
Description 

This command specifies a password type or configures password string for pap or chap. The pap and chap passwords are stored in a hashed format in the config files. The hash|hash2 optional keywords are used for config execution.

This command will only be interpreted if the local user database is connected directly to the PPPoE node under the VPRN/IES group interface. It is not used if the local user database is accessed by a local DHCP server.

The no form of this command reverts to the default.

Parameters 
ignore—
Specifies that the password will be ignored, in which case authentication will always succeed, independent of the password used by the PPPoE client. The client must still perform authentication.
string—
Specifies that the password for Challenge-Handshake Authentication Protocol) (CHAP) is used. Only a password received with the CHAP protocol will be accepted.
string—
Specifies that the Password Authentication Protocol (PAP) is used. Only a password received with the PAP protocol will be accepted, even though the CHAP protocol will be proposed to the client first because it is unknown at the time of the offer which password type will be allowed to the client.
hash|hash2—
Specifies hashing scheme
custom—
Specifies the custom encryption to management interface.

pre-auth-policy

Syntax 
pre-auth-policy policy-name
no pre-auth-policy
Context 
config>subscr-mgmt>loc-user-db>ppp>host
Description 

This command configures the RADIUS pre-authentication policy to use to authenticate the PPP host.

The no form of this command reverts to the default.

Parameters 
policy-name—
Specifies the pre-authentication policy of the host, up to 32 characters.

steering-profile.

Syntax 
steering-profile steering-profile-name
no steering-profile
Context 
config>subscr-mgmt>loc-user-db>ppp>host
Description 

This command configures the steering profile for the specific host.

The no form of this command removes the steering profile for the host.

Parameters 
steering-profile-name —
Specifies the name of the steering profile, up to 32 characters.

ignore-df-bit

Syntax 
[no] ignore-df-bit
Context 
config>subscr-mgmt>loc-user-db>ppp>host
Description 

When this command is enabled for a subscriber host, the do-not-fragment (DF) bit in the IPv4 header for frames egressing the subscriber interface is ignored, the frames are fragmented according the applicable egress MTU. The DF bit is reset for frames that are fragmented.

This command applies to PPPoE PTA and L2TP LNS frames only. It is not applicable for L2TP LAC frames.

interface

Syntax 
interface ip-int-name service-id service-id
no interface
Context 
config>subscr-mgmt>loc-user-db>ppp>host
Description 

This command configures the interface where PPP sessions are terminated.

The no form of this command reverts to the default.

Parameters 
ip-int-name—
Specifies the name of the group interface, up to 32 characters, where the PPP sessions are established.
service-id—
Specifies the service ID or name of the service where the PPP sessions are established.
Values—
service-id — 1 to 2147483647
service-name — up to 64 characters

 

server-id

Syntax 
server-id duid-en hex hex-string
server-id duid-en string ascii-string
server-id duid-ll
no server-id
Context 
config>service>ies>sub-if>grp-if>ipv6>dhcp6>proxy
config>service>vprn>sub-if>grp-if>ipv6>dhcp6>proxy
config>router>dhcp6>server
config>service>vprn>dhcp6>server
Description 

This command allows the operator to customize the server-id attribute of a DHCPv6 message (such as DHCPv6 advertise and reply). By default, the server-id uses DUID-ll derived from the chassis link layer address. Operators have the option to use a unique identifier by using the duid-en (vendor based on an enterprise number). There is a maximum length associated with the customizable hex-string and ascii-string.

The no form of this command reverts to the default.

Default 

server-id duid-ll

Parameters 
hex-string—
Specifies a DUID system ID in a hex format.
Values—
0x0 to 0xFFFFFFFF (maximum 116 hex nibbles)

 

ascii-string—
Specifies a DUID system ID in an ASCII format, up to 58 characters.
duid-ll—
Specifies that the DUID system ID is derived from the system link layer address.
duid-en—
Specifies the enterprise number.

on-link

Syntax 
[no] on-link
Context 
config>router>router-advert>if
config>service>ies>sub-if>ipv6>rtr-adv>pfx-opt
config>service>ies>sub-if>grp-if>ipv6>rtr-adv>pfx-opt
config>service>vprn>router-advert>if
config>service>vprn>sub-if>ipv6>rtr-adv>pfx-opt
config>service>vprn>sub-if>grp-if>ipv6>rtr-adv>pfx-opt
Description 

This command specifies whether the prefix is assigned to an interface on the specified link.

The no form of this command reverts to the default.

3.6.2.1.4. Managed SAP Policy Commands

msap-policy

Syntax 
msap-policy msap-policy-name [create]
no msap-policy msap-policy-name
Context 
config>subscr-mgmt
Description 

This command configures a managed SAP policy. Managed SAPs allow the use of policies and a SAP template for the creation of a SAP.

The no form of this command removes the MSAP policy from the configuration.

Parameters 
msap-policy-name—
Specifies the managed SAP policy name up to 32 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.
create—
Keyword used to create the managed SAP policy. The create keyword requirement can be enabled or disabled in the environment>create context.

vpls-only-sap-parameters

Syntax 
vpls-only-sap-parameters
Context 
config>subscr-mgmt>msap-policy
Description 

This command enables the context to configure MSAP VPLS properties.

dhcp

Syntax 
dhcp
Context 
config>subscr-mgmt>msap-policy>vpls-only
Description 

This command enables the context to configure DHCP parameters.

3.6.2.1.5. Local DHCP Server Commands

local-dhcp-server

Syntax 
local-dhcp-server server-name [create]
no local-dhcp-server server-name
Context 
config>router>dhcp
config>service>vprn>dhcp
Description 

This command instantiates a local DHCP server. A local DHCP server can serve multiple interfaces but is limited to the routing context it was which it was created.

The no form of this command reverts to the default.

Parameters 
server-name —
Specifies the name of local DHCP server
create—
Keyword used to create the local DHCP server. The create keyword requirement can be enabled or disabled in the environment>create context.

failover

Syntax 
failover
Context 
config>router>dhcp>server
config>router>dhcp>server>pool
config>router>dhcp6>server
config>router>dhcp6>server>pool
config>service>vprn>dhcp>server
config>service>vprn>dhcp>server>pool
config>service>vprn>dhcp6>server
config>service>vprn>dhcp6>server>pool
Description 

This command enables the context to configure failover parameters.

ignore-mclt-on-takeover

Syntax 
[no] ignore-mclt-on-takeover
Context 
config>router>dhcp>server>failover
config>router>dhcp>server>pool>failover
config>router>dhcp6>server>failover
config>router>dhcp6>server>pool>failover
config>service>vprn>dhcp>server>failover
config>service>vprn>dhcp>server>pool>failover
config>service>vprn>dhcp6>server>failover
config>service>vprn>dhcp6>server>pool>failover
Description 

With this flag enabled, the remote IP address or prefix can be taken over immediately upon entering the PARTNER-DOWN state of the intercommunication link, without having to wait for the Maximum Client Lead Time (MCLT) to expire. By setting this flag, the lease times of the existing DHCP clients, while the intercommunication link is in the PARTNER-DOWN state, will still be reduced to the MCLT over time and all new lease times are set to MCLT. This behavior remains the same as originally intended for MCLT.

Some deployments require that the remote IP address/prefix range starts delegating new IP addresses and prefixes upon the failure of the intercommunication link, without waiting for the intercommunication link to transition from the COMM-INT state into the PARTNER-DOWN state and the MCLT to expire while in PARTNER-DOWN state.

This can be achieved by enabling the ignore-mclt-on-takeover flag and by configuring the partner-down-delay to 0.

Enabling this functionality must be exercised with caution. One needs to keep in mind that the partner-down-delay and MCLT timers were originally introduced to prevent IP address duplication in cases where DHCP redundant nodes transition out-of-sync due to the failure of intercommunication link. These timers (partner-down-delay and MCLT) would ensure that during their duration, the new IP addresses and prefixes are delegated only from one node, the one with local IP address-range/prefix. This causes the new IP address delegation to be delayed and the service is impacted.

If it can be assured that the intercommunication link is always available, then the DHCP nodes would stay in sync and the two timers would not be needed. Therefore, it is important that in this mode of operation, the intercommunication link is well protected by providing multiple paths between the two DHCP nodes. The only event that should cause intercommunication link to fail is the entire nodal failure. This failure is acceptable since in this case only one DHCP node is available to provide new IP addresses and prefixes.

The no form of this command reverts to the default.

maximum-client-lead-time

Syntax 
maximum-client-lead-time [hrs hours] [min minutes] [sec seconds]
no maximum-client-lead-time
Context 
config>router>dhcp>server>failover
config>router>dhcp>server>pool>failover
config>service>vprn>dhcp>server>failover
config>service>vprn>dhcp>server>pool>failover
config>router>dhcp6>server>failover
config>router>dhcp6>server>pool>failover
config>service>vprn>dhcp6>server>failover
config>service>vprn>dhcp6>server>pool>failover
Description 

The maximum-client-lead-time (MCLT) is the maximum time that a DHCP server can extend client’s lease time beyond the lease time currently known by the DHCP partner node. In dual-homed environment, the initial lease time for all DHCP clients is by default restricted to MCLT. Consecutive DHCP renews can extend the lease time beyond the MCLT.

The MCLT is a safeguard against IP address/prefix duplication in cases of a lease synchronization failure when local-remote failover model is deployed

Once the intercommunication link failure between the redundant DHCP servers is detected, the DHCP IP address range configured as remote will not be allowed to start delegating new leases until the MCLT + partner-down-delay intervals expire. This is to ensure that the new lease that was delegated from the local IP address-range/prefix on one node but was never synchronized due to the intercommunication link failure, will expire before the same IP address/prefix is allocated from the remote IP address-range/prefix on the other node.

However, the already existing (and synchronized) lease times can be renewed from the remote IP address range at any time, regardless of the state of the intercommunication link (operational or failed).

Lease synchronization failure can be caused either by a node failure, or a failure of the link over which the DHCP leases are synchronized (intercommunication link). Synchronization failure detection can take up to 3 seconds.

During the failure, the DHCP lease time for the new clients is restricted to MCLT while for the existing clients the lease time will over time (by consecutive DHCP renews) be gradually reduced to the MCLT.

The no form of this command reverts to the default.

Default 

maximum-client-lead-time min 10

Parameters 
maximum-client-lead-time—
Specifies the maximum client lead time
Values—

hrs hours

1 to 23

min minutes

1 to 59

sec seconds

1 to 59

 

partner-down-delay

Syntax 
partner-down-delay [hrs hours] [min minutes] [sec seconds]
no partner-down-delay
Context 
config>router>dhcp>server>failover
config>router>dhcp>server>pool>failover
config>service>vprn>dhcp>server>failover
config>service>vprn>dhcp>server>pool>failover
config>router>dhcp6>server>failover
config>router>dhcp6>server>pool>failover
config>service>vprn>dhcp6>server>failover
config>service>vprn>dhcp6>server>pool>failover
Description 

This command configures the partner down delay time. Since the DHCP lease synchronization failure can be caused by the failure of the intercommunication link (and not necessary the entire node), there is a possibility the redundant DHCP servers become isolated in the network. In other words, they can serve DHCP clients but they cannot synchronize the lease. This can lead to duplicate assignment of IP addresses, since the servers have configured overlapping IP address ranges but they are not aware of each other’s leases.

The purpose of the partner down delay is to prevent the IP lease duplication during the intercommunication link failure by not allowing new IP addresses to be assigned from the remote IP address range. This timer is intended to provide the operator with enough time to remedy the failed situation and to avoid duplication of IP addresses or prefixes during the failure.

During the partner-down-delay time, the prefix designated as remote is eligible only for renewals of the existing DHCP leases that have been synchronized by the peering node. Only after the sum of the partner-down-delay and the maximum-client-lead-time will the prefix designated as remote be eligible for delegation of the new DHCP leases. When this occurs, we say that the remote IP address range has been taken over.

It is possible to expedite the takeover of a remote IP address range so that the new IP leases can start being delegated from that range shortly after the intercommunication failure is detected. This can be achieved by configuring the partner-down-delay timer to 0 seconds, along with enabling the ignore-mclt-on-takeover CLI flag. Caution must be taken before enabling this functionality. It is safe to bypass safety timers (partner-down-delay + MCLT) only in cases where the operator is certain that the intercommunication between the nodes has failed due to the entire node failure and not due to the intercommunication (MCS) link failure. Failed intercommunication due to the nodal failure would ensure that only one node is present in the network for IP address delegation (as opposed to two isolated nodes with overlapping IP address ranges where address duplication can occur). For this reason, the operator must ensure that there are redundant paths between the nodes to ensure uninterrupted synchronization of DHCP leases.

In access-driven mode of operation, partner-down-delay has no effect.

The no form of this command reverts to the default.

Default 

partner-down-delay hrs 23 min 59 sec 59

Parameters 
partner-down-delay—
Specifies the partner down delay time
Values—

hrs hours

1 to 23

min minutes

1 to 59

sec seconds

0 to 59

 

peer

Syntax 
peer ip-address tag sync-tag
no peer
Context 
config>router>dhcp>server>failover
config>router>dhcp>server>pool>failover
config>router>dhcp6>server>failover
config>router>dhcp6>server>pool>failover
config>service>vprn>dhcp>server
config>service>vprn>dhcp>server>pool
config>service>vprn>dhcp6>server
config>service>vprn>dhcp6>server>pool
Description 

This command creates a sync tag. DHCP leases can be synchronized per DHCP server or DHCP pool. The pair of synchronizing servers or pools is identified by a tag. The synchronization information is carried over the Multi-Chassis Synchronization (MCS) link between the two peers. MCS link is a logical link (IP, or MPLS).

MCS runs over TCP, port 45067 and it is using either data traffic or keepalives to detect failure on the communication link between the two nodes. In the absence of any MCS data traffic for more than 0.5sec, MCS will send its own keepalive to the peer. If a reply is not received within three sec, MCS will declare its operation state as DOWN and the DB Sync state as out-of-sync. MCS will consequently notify its clients (DHCP Server being one of them) of this. It can take up to three seconds before the DHCP client realizes that the inter-chassis communication link has failed.

The inter-chassis communication link failure does not necessarily assume the same failed fate for the access links. The two redundant nodes can become isolated from each other in the network. This occurs when only the intercommunication (MCS) link fails. It is important that this MCS link be highly redundant.

The no form of this command reverts to the default.

Parameters 
ip-address—
Specifies the IPv4 or IPv6 address of the peer.
tag sync-tag—
Specifies a tag that will identify synchronizing DHCP servers or pools.

startup-wait-time

Syntax 
startup-wait-time [min minutes] [sec seconds] [hrs hours]
no startup-wait-time [min minutes] [sec seconds]
Context 
config>router>dhcp>server>failover
config>router>dhcp>server>pool>failover
config>router>dhcp6>server>failover
config>router>dhcp6>server>pool>failover
Description 

This command enables the startup wait time during which each peer waits after the initialization process before assuming the active role for the prefix designated as local or access-driven. This is to avoid transient issues during the initialization process.

The startup-wait-time should be configured to an interval in which, after boot, both nodes can set up an MCS TCP link and start MCS. The timer is restarted each time the server downloads a lease from the MCS database and stops when the last state record from the peer is synchronized. The next state is (PRE-)NORMAL, unless the timer times out or is forced to stop via the tools command (tools>perform>router>dhcp or dhcp6>local-dhcp-server server-name>pool/failover>abort-startup-wait), in which case the local DHCP server transitions immediately to the COMMUNICATIONS-INTERRUPTED state.

Default 

startup-wait-time min 2

Parameters 
minutes—
Specifies the startup wait time, in minutes
Values—
1 to 59

 

seconds—
Specifies the startup wait time, in seconds
Values—
1 to 59

 

hours—
Specifies the startup wait time, in hours
Values—
1

 

force-renews

Syntax 
[no] force-renews
Context 
config>router>dhcp>server
config>service>vprn>server
Description 

This command enables the sending of sending FORCERENEW messages for DHCP.

The no form of this command disables the sending of FORCERENEW messages.

lease-hold-time

Syntax 
lease-hold-time [days days] [hrs hours] [min minutes] [sec seconds]
no lease-hold-time
Context 
config>router>dhcp>server
config>router>dhcp6>server
config>service>vprn>dhcp>server
config>service>vprn>dhcp6>server
Description 

This command configures the time to remember this lease and is applicable for unsolicited release conditions such as lease timeout if the lease-hold-time-for command is set to the default value no solicited-release and is additionally applicable for normal solicited releases from DHCP clients if the lease-hold-time-for command is set to solicited-release.

The no form of this command reverts to the default.

Default 

lease-hold-time sec 0

Parameters 
lease-hold-time—
Specifies the amount of time to remember the lease.
Values—

days days

0 to 7305

hrs hours

0 to 23

min minutes

0 to 59

sec seconds

0 to 59

 

lease-hold-time-for

Syntax 
[no] lease-hold-time-for
Context 
config>router>dhcp>server
config>router>dhcp6>server
config>service>vprn>dhcp>server
config>service>vprn>dhcp6>server
Description 

This command enables the context to configure lease-hold-time-for parameters which define additional types of lease or triggers that cause system to hold up leases.

The no form of this command reverts to the default.

internal-lease-ipsec

Syntax 
[no] internal-lease-ipsec
Context 
config>router>dhcp>server>lease-hold-time-for
config>router>dhcp6>server>lease-hold-time-for
config>service>vprn>dhcp>server>lease-hold-time-for
config>service>vprn>dhcp6>server>lease-hold-time-for
Description 

This command enables the server to hold up the lease of local IPsec clients.

The no form of this command disables the ability of the server to hold up the lease of local IPsec clients.

solicited-release

Syntax 
[no] solicited-release
Context 
config>service>vprn>dhcp6>server>lease-hold-time-for
config>router>dhcp6>server>lease-hold-time-for
config>service>vprn>dhcp>server>lease-hold-time-for
config>router>dhcp>server>lease-hold-time-for
Description 

This command enables the server to hold up a lease even in case of solicited release; for example, when the server receives a normal DHCP release message.

The no form of this command disables the ability of the server to hold up a lease when a solicited release is received.

pool

Syntax 
pool pool-name [create]
no pool pool-name
Context 
config>router>dhcp>server
config>router>dhcp6>server
config>service>vprn>dhcp>server
config>service>vprn>dhcp6>server
Description 

This command configures a DHCP address pool on the router.

The no form of this command removes the pool name from the configuration.

Parameters 
pool name—
Specifies the name of this IP address pool. Allowed values are any string, up to 32 characters.
create—
Keyword used to create the pool. The create keyword requirement can be enabled or disabled in the environment>create context.

max-lease-time

Syntax 
max-lease-time [max-lease-time]
no max-lease-time
Context 
config>router>dhcp>server>pool
Description 

This command configures the maximum lease time.

The no form of this command reverts to the default.

Default 

max-lease-time days 10

Parameters 
max-lease-time—
Specifies the maximum lease time.
Values—

days days

0 to 3650

hrs hours

0 to 23

min minutes

0 to 59

sec seconds

0 to 59

 

min-lease-time

Syntax 
min-lease-time [min-lease-time]
no min-lease-time
Context 
config>router>dhcp>server>pool
config>service>vprn>dhcp>server>pool
Description 

This command configures the minimum lease time.

The no form of this command reverts to the default.

Default 

min-lease-time min 10

Parameters 
min-lease-time—
Specifies the minimum lease time.
Values—

days days

0 to 3650

hrs hours

0 to 23

min minutes

0 to 59

sec seconds

0 to 59

 

minimum-free

Syntax 
minimum-free minimum-free [percent] [event-when-depleted]
no minimum-free
Context 
config>router>dhcp>server>pool
config>router>dhcp6>server>pool
config>service>vprn>dhcp>server>pool
Description 

This command specifies the desired minimum number of free addresses in this pool.

The no form of this command reverts to the default.

Default 

minimum-free 1

Parameters 
minimum-free—
Specifies the minimum number of free addresses
Values—
0 to 255

 

percent—
Specifies that the value indicates a percentage
event-when-depleted—
This parameter enables a system-generate event when all available addresses in the pool/subnet of local DHCP server are depleted.

nak-non-matching-subnet

Syntax 
[no] nak-non-matching-subnet
Context 
config>router>dhcp>server>pool
config>service>vprn>dhcp>server>pool
Description 

With this command, if the local DHCPv4 server receives a DHCP request with option 50 (means client try to request a previous allocated message as described in section 3.2 of RFC 2131, Dynamic Host Configuration Protocol) and the address allocation algorithm ends up using a pool and the address in option50 is not in pool, then system will return a DHCP NAK, otherwise system just drop the DHCP packet.

The no form of this command reverts to the default.

Default 

no nak-non-matching-subnet

offer-time

Syntax 
offer-time [min minutes] [sec seconds]
no offer-time
Context 
config>router>dhcp>server>pool
config>service>vprn>dhcp>server>pool
Description 

This command configures the time interval during which a DHCP offer is valid.

The no form of this command reverts to the default.

Default 

offer-time min 1

Parameters 
time—
Specifies the offer time
Values—

min minutes

0 to 10

sec seconds

0 to 59

 

options

Syntax 
options
Context 
config>router>dhcp6>server>defaults
config>router>dhcp>server>pool
config>router>dhcp>server>pool>subnet
config>router>dhcp6>server>pool
config>router>dhcp6>server>pool>prefix
config>subscr-mgmt>loc-user-db>ipoe>host
config>subscr-mgmt>loc-user-db>ppp>host
config>service>vprn>dhcp>server>pool
config>service>vprn>dhcp6>server>pool
config>service>vprn>dhcp6>server>pool>prefix
Description 

This command enables the context to configure pool options. The options defined here can be overruled by defining the same option in the local user database.

custom-option

Syntax 
custom-option option-number address [ip-address]
custom-option option-number domain [domain-string]
custom-option option-number hex hex-string
custom-option option-number string ascii-string
no custom-option option-number
Context 
config>router>dhcp>server>pool>options
config>router>dhcp>server>pool>subnet>options
config>service>vprn>dhcp>server>pool>options
config>subscr-mgmt>loc-user-db>ipoe>host>options
config>subscr-mgmt>loc-user-db>ppp>host>options
Description 

This command configures specific DHCP options. The options defined here can overrule options in the local user database.

The no form of the removes the custom option parameters from the configuration.

Parameters 
option-number—
Specifies up to four option numbers that the DHCP server uses to send the identification strings to the DHCP client.
Values—
1 to 254

 

ip-address—
Specifies the IP address of a host.
domain-string—
Specifies the domain name, up to 127 characters.
hex-string—
Specifies the hex value of this option.
Values—
0x0 to 0xFFFFFFFF (up to 254 hex nibbles)

 

ascii-string—
Specifies the value of this option, up to 127 characters.

default-router

Syntax 
default-router ip-address [ip-address]
no default-router
Context 
config>router>dhcp>server>pool>subnet>options
config>service>vprn>dhcp6>server>pool>subnet
config>subscr-mgmt>loc-user-db>ipoe>host>options
Description 

This command configures the IP address of the default router for a DHCP client. Up to four IP addresses can be specified.

The no form of this command removes the address(es) from the configuration.

Parameters 
ip-address—
Specifies up to four default router IP addresses. Each address must be unique within the subnet and specified in dotted decimal notation. Allowed values are IP addresses in the range 1.0.0.0 – 223.255.255.255 (with support of /31 subnets).

lease-rebind-time

Syntax 
lease-rebind-time [days days] [hrs hours] [min minutes] [sec seconds]
no lease-rebind-time
Context 
config>router>dhcp>server>pool>options
config>service>vprn>dhcp>server>pool>options
config>subscr-mgmt>loc-user-db>ipoe>host>options
Description 

This command configures the time the client transitions to a rebinding state for a DHCP client.

The no form of this command removes the time from the configuration.

Parameters 
lease-rebind-time—
Specifies the lease rebind time.
Values—

days days

0 to 3650

hrs hours

0 to 23

min minutes

0 to 59

sec seconds

0 to 59

 

lease-renew-time

Syntax 
lease-renew-time [days days] [hrs hours] [min minutes] [sec seconds]
no lease-renew-time
Context 
config>router>dhcp>server>pool>options
config>service>vprn>dhcp>server>pool>options
config>subscr-mgmt>loc-user-db>ipoe>host>options
Description 

This command configures the time the client transitions to a renew state for a DHCP client.

The no form of this command removes the time from the configuration.

Parameters 
lease-renew-time—
Specifies the lease renew time.
Values—

days:

0 to 3650

hours:

0 to 23

minutes:

0 to 59

seconds

0 to 59

 

lease-time

Syntax 
lease-time [days days] [hrs hours] [min minutes] [sec seconds]
no lease-time
Context 
config>router>dhcp>server>pool>options
config>service>vprn>dhcp>server>pool>options
config>subscr-mgmt>loc-user-db>ipoe>host>options
Description 

This command configures the amount of time that the DHCP server grants to the DHCP client permission to use a specific IP address.

The no form of this command removes the lease time parameters from the configuration.

Parameters 
lease-time—
Specifies the lease time.
Values—

days days

0 to 3650

hrs hours

0 to 23

min minutes

0 to 59

sec seconds

0 to 59

 

netbios-name-server

Syntax 
netbios-name-server ip-address [ip-address]
no netbios-name-server
Context 
config>router>dhcp>server>pool>options
config>service>vprn>dhcp>server>pool>options
config>subscr-mgmt>loc-user-db>ipoe>host>options
config>subscr-mgmt>loc-user-db>ppp>host>options
Description 

This command configures up to four Network Basic Input/Output System (NetBIOS) name server IP addresses for a DHCP client.

The no form of this command removes the IP address from the netbios-name-server configuration.

Parameters 
ip-address—
Specifies up to four NetBIOS name server IP addresses. The address must be unique within the subnet and specified in dotted decimal notation. Allowed values are IP addresses in the range 1.0.0.0 – 223.255.255.255 (with support of /31 subnets).

netbios-node-type

Syntax 
netbios-node-type netbios-node-type
no netbios-node-type
Context 
config>router>dhcp>server>pool>options
config>subscr-mgmt>loc-user-db>ipoe>host>options
config>service>vprn>dhcp>server>pool>options
Description 

This command configures the Network Basic Input/Output System (NetBIOS) node type.

The no form of this command removes the netbios node type parameters from the configuration.

Parameters 
netbios-node-type—
Specifies the netbios node type.
Values—
B — Broadcast node uses broadcasting to query nodes on the network for the owner of a NetBIOS name.
P — Peer-to-peer node uses directed calls to communicate with a known NetBIOS name server for the IP address of a NetBIOS machine name.
M — Mixed node uses broadcast queries to find a node, and if that fails, queries a known P-node name server for the address.
H — Hybrid node is the opposite of the M-node action so that a directed query is executed first, and if that fails, a broadcast is attempted.

 

subnet

Syntax 
subnet {ip-address/mask | ip-address netmask} [create]
no subnet {ip-address/mask | ip-address netmask}
Context 
config>router>dhcp>server>pool
config>service>vprn>dhcp>server>pool
Description 

This command creates a subnet of IP addresses to be served from the pool. The subnet cannot include any addresses that were assigned to subscribers without those addresses specifically excluded. When the subnet is created, no IP addresses are made available until a range is defined.

The no form of the removes the subnet parameters from the configuration.

Parameters 
ip-address—
Specifies the base IP address of the subnet. This address must be unique within the subnet and specified in dotted decimal notation. Allowed values are IP addresses in the range 1.0.0.0 – 223.255.255.255 (with support of /31 subnets).
mask—
The subnet mask in dotted decimal notation. Allowed values are dotted decimal addresses in the range 128.0.0.0 – 255.255.255.252.
Note:

A mask of 255.255.255.255 is reserved for system IP addresses.

netmask—
Specifies a string of 0s and 1s that mask or screen out the network part of an IP address so that only the host computer part of the address remains
create—
Keyword used to create the subnet. The create keyword requirement can be enabled or disabled in the environment>create context.

address-range

Syntax 
no address-range start-ip-address end-ip-address [failover {local | remote | access-driven}]
no address-range start-ip-address end-ip-address
Context 
config>router>dhcp>server>pool>subnet
config>service>vprn>dhcp>server>pool
Description 

This command configures a range of IP addresses to be served from the pool. All IP addresses between the start and end IP addresses will be included (other than specific excluded addresses).

The no form of this command removes the address-range parameters from the configuration.

Parameters 
start-ip-address—
Specifies the start address of this range to include. This address must be unique within the subnet and specified in dotted decimal notation. Allowed values are IP addresses in the range 1.0.0.0 – 223.255.255.255 (with support of /31 subnets).
end-ip-address—
Specifies the end address of this range to include. This address must be unique within the subnet and specified in dotted decimal notation. Allowed values are IP addresses in the range 1.0.0.0 – 223.255.255.255 (with support of /31 subnets).
local—
Specifies that the local DHCP server has the ownership of this dress range in a redundant setup under normal operation.
remote—
Specifies that the remote DHCP server has the ownership of this address range in a redundant setup under normal operation.
access-driven—
Specifies that the DHCP server failover system is in control by the access protection mechanisms (SRRP or MC-LAG).

drain

Syntax 
[no] drain
Context 
config>service>vprn>dhcp>server>pool>subnet
Description 

This command means no new leases can be assigned from this subnet and existing leases are cleaned up upon renew/rebind.

The no form of this command means the subnet is active and new leases can be assigned from it.

exclude-addresses

Syntax 
[no] exclude-addresses start-ip-address [end-ip-address]
Context 
config>router>dhcp>server>pool>subnet
config>service>vprn>dhcp>server>pool>subnet
Description 

This command specifies a range of IP addresses that excluded from the pool of IP addresses in this subnet.

The no form of the removes the parameters from the configuration.

Parameters 
start-ip-address—
Specifies the start address of this range to exclude. This address must be unique within the subnet and specified in dotted decimal notation. Allowed values are IP addresses in the range 1.0.0.0 – 223.255.255.255 (with support of /31 subnets).
end-ip-address—
Specifies the end address of this range to exclude. This address must be unique within the subnet and specified in dotted decimal notation. Allowed values are IP addresses in the range 1.0.0.0 – 223.255.255.255 (with support of /31 subnets).

maximum-declined

Syntax 
maximum-declined maximum-declined
no maximum-declined
Context 
config>router>dhcp>server>pool>subnet
config>service>vprn>dhcp>server>pool>subnet
Description 

This command configures the maximum number of declined addresses allowed.

The no form of the reverts to the default.

Default 

maximum-declined 64

Parameters 
maximum-declined—
Specifies the maximum number of declined addresses allowed
Values—
0 to 4294967295

 

minimum-free

Syntax 
minimum-free minimum-free [percent] [event-when-depleted]
no minimum-free
Context 
config>router>dhcp>server>pool>subnet
config>router>dhcp6>server>pool>subnet
config>service>vprn>dhcp>server>pool>subnet
config>service>vprn>dhcp6>server>pool>subnet
Description 

This command configures the minimum number of free addresses in this subnet. If the actual number of free addresses in this subnet falls below this configured minimum, a notification is generated.

The no form of the reverts to the default.

Default 

minimum-free 1

Parameters 
minimum-free—
Specifies the minimum number of free addresses in this subnet.
Values—
0 to 255

 

percent—
Specifies that the value indicates a percentage.
event-when-depleted—
Enables a system-generate event when all available addresses in the pool/subnet of local DHCP server are depleted.

subnet-mask

Syntax 
subnet-mask ip-address
no subnet-mask
Context 
config>router>dhcp>server>pool>subnet>options
config>subscr-mgmt>loc-user-db>ipoe>host>options
Description 

This command specifies the subnet-mask option to the client. The mask can either be defined (for supernetting) or taken from the pool address.

The no form of this command removes the address from the configuration.

Parameters 
ip-address—
Specifies the IP address of the subnet mask. This address must be unique within the subnet and specified in dotted decimal notation. Allowed values are IP addresses in the range 1.0.0.0 – 223.255.255.255 (with support of /31 subnets).

use-gi-address

Syntax 
use-gi-address [scope scope]
Context 
config>router>dhcp>server
config>service>vprn>dhcp>server
Description 

This command enables the use of gi-address matching. If the gi-address flag is enabled, a pool can be used even if a subnets is not found. If the local-user-db-name is not used, the gi-address flag is used and addresses are handed out by GI only. If a user must be blocked from getting an address the server maps to a local user database and configures the user with no address.

A pool can include multiple subnets. Since the GI is shared by multiple subnets in a subscriber interface the pool may provide IP addresses from any of the subnets included when the GI is matched to any of its subnets. This allows a pool to be created that represents a sub-int.

The no form of the reverts to the default.

Parameters 
scope—
Specifies if addresses are handed out for a certain subnet where the gi-address belongs to only or for all subnets part of the pool
Values—
subnet — Addresses are only handed out for the subnet where the gi-address is part.
pool — All subnets part of the pool which contain subnet where the gi-address is part of can hand out addresses.

 

use-pool-from-client

Syntax 
use-pool-from-client delimiter delimiter
use-pool-from-client
no use-pool-from-client
Context 
config>router>dhcp>server
config>service>vprn>dhcp>server
Description 

This command enables the use of the pool indicated by DHCP client. When enabled, the IP address pool to be used by this server is the pool is indicated by the vendor-specific sub-option 13 of the DHCP option 82. When disabled or if there is no sub-option 13 in the DHCP message, the pool selection falls back to the use-gi-address configuration.

The no form of this command disables the use of the pool indicated by DHCP client.

Parameters 
delimiter—
A single ASCII character specifies the delimiter of separating primary and secondary pool names in Option82 VSO

user-db

Syntax 
user-db local-user-db-name [create]
no user-db
Context 
config>router>dhcp>server
config>service>ies>sub-if>grp-if>dhcp
config>service>ies>sub-if>grp-if>dhcp6
config>service>ies>sub-if>grp-if>ipv6>dhcp6
config>service>ies>sub-if>grp-if>ipv6>dhcp6
config>service>vprn>sub-if>grp-if>dhcp
config>service>vprn>sub-if>grp-if>dhcp6
config>service>vprn>sub-if>grp-if>ipv6>dhcp6
config>service>ies>sub-if>grp-if>ipv6>dhcp6
Description 

This command configures a local user database for authentication.

The no form of this command reverts to the default.

Parameters 
local-user-db-name —
Specifies the name of a user database, up to 32 characters
create—
Keyword used to create the user database. The create keyword requirement can be enabled or disabled in the environment>create context.

user-ident

Syntax 
user-ident user-ident
no user-ident
Context 
config>router>dhcp>server
config>service>vprn>dhcp>server
Description 

This command configures the user identification method for the DHCPv4 server.

The no form of the reverts to the default.

Default 

user-ident mac-circuit-id

Parameters 
user-ident—
Specifies the user identification method
Values—
client-id — Specifies to use the DHCPv4 client identifier as the user identification method.
circuit-id — Specifies to use the circuit identifier of the DHCPv4 client as the user identification method.
mac — Specifies to use the MAC address of the DHCPv4 client as the user identification method.
mac-circuit-id — Specifies to use the MAC address and circuit identifier of the DHCPv4 client as the user identification method.
remote-id — Specifies to use the MAC address of the remote end as the user identification method.

 

3.6.2.1.6. Local DHCP6 Server Commands

local-dhcp-server

Syntax 
local-dhcp-server server-name [create] [auto-provisioned]
no local-dhcp-server server-name
Context 
config>router>dhcp6
Description 

This command instantiates a DHCP6 server. A local DHCP6 server can serve multiple interfaces but is limited to the routing context it was which it was created.

The no form of this command reverts to the default.

Parameters 
server-name —
Specifies the name of local DHCP6 server.
create—
Keyword used to create the local DHCP or DHCP6 server. The create keyword requirement can be enabled or disabled in the environment>create context.
auto-provisioned—
Specifies the auto provisioning mode. This parameter only applies to DHCP6 creation to configure DHCP6 default values.

allow-lease-query

Syntax 
[no] allow-lease-query
Context 
config>router>dhcp6>server
config>service>vprn>dhcp6>server
Description 

If enabled, the local DHCPv6 server will handle and reply to lease query messages.

The no form of this command disables lease query support.

defaults

Syntax 
defaults
Context 
config>router>dhcp6>server
config>service>vprn>dhcp6>defaults
Description 

This command configures server default timer and option values. These can be overridden on a per-pool and per-prefix basis.

preferred-lifetime

Syntax 
preferred-lifetime [days days] [hrs hours] [min minutes] [sec seconds]
no preferred-lifetime
Context 
config>router>dhcp6>server>defaults
config>service>vprn>dhcp6>defaults
Description 

This command configures the default preferred lifetime.

The no form of this command reverts to the default value.

Default 

preferred-lifetime hrs 1

Parameters 
preferred-lifetime—
Specifies the prefered time for a prefix.
Values—

days days

0 to 3650

hrs hours

0 to 23

min minutes

0 to 59

sec seconds

0 to 59

 

rebind-timer

Syntax 
rebind-timer [rebind-timer]
no rebind-timer
Context 
config>router>dhcp6>server>defaults
config>service>vprn>dhcp6>defaults
config>service>vprn>dhcp6>server>pool>prefix
Description 

This command configures the default rebind timer.

The no form of this command reverts to the default.

Default 

rebind-timer sec 0

Parameters 
rebind-timer—
Specifies the timer after which the lease should use rebind upon a renew failure.
Values—

days days

0 to 14

hrs hours

0 to 23

min minutes

0 to 59

sec seconds

0 to 9

 

renew-timer

Syntax 
renew-timer [renew-timer]
no renew-timer
Context 
config>router>dhcp6>server>defaults
Description 

This command configures the default renew timer

The no form of this command reverts to the default.

Default 

renew-timer min 30

Parameters 
renew-timer—
Specifies the timer after which the lease is renewed.
Values—

days days

0 to 7

hrs hours

0 to 23

min minutes

0 to 59

sec seconds

0 to 59

 

valid-lifetime

Syntax 
valid-lifetime [valid-lifetime]
no valid-lifetime
Context 
config>router>dhcp6>server>defaults
Description 

This command configures the valid lifetime.

The no form of this command reverts to the default.

Default 

valid-lifetime days 1

Parameters 
valid-lifetime—
Specifies the valid lifetime for a prefix to remain valid.
Values—

days days

0 to 3650

hrs hours

0 to 23

min minutes

0 to 59

sec seconds

0 to 9

 

ignore-rapid-commit

Syntax 
[no] ignore-rapid-commit
Context 
config>router>dhcp6>server
config>service>vprn>dhcp6>server
Description 

This command enables the Rapid Commit Option for DHCP6.

The no form of this command disables the Rapid Commit Option.

interface-id-mapping

Syntax 
[no] interface-id-mapping
Context 
config>router>dhcp6>server
config>service>vprn>dhcp6>server
Description 

If enabled, this command enables the behavior where unique /64 prefix is allocated per interface-id, and all clients having the same interface-id get an address allocated out of this /64 prefix for DHCP6. This is relevant for bridged clients behind the same local-loop (and same SAP), where sharing the same prefix allows communication between bridged clients behind the same local-loop to stay local. For SLAAC based assignment, downstream neighbor-discovery is automatically enabled to resolve the assigned address.

The no form of this command reverts to the default.

delegated-prefix-length

Syntax 
delegated-prefix-length bits [minimum prefix-length] [maximum prefix-length]
no delegated-prefix-length
Context 
config>router>dhcp6>server>pool
config>service>vprn>dhcp6>server>pool
Description 

This command configures the delegated prefix length that is used if the DHCPv6 client does not specify a prefix length hint.

The DHCPv6 client prefix length hint is limited by the range specified by the minimum and maximum parameters. If the hint is smaller than the minimum, the allocated prefix length is equal to the minimum length. If the hint is larger than the maximum, the allocated prefix length is equal to the maximum length.

The no form of this command reverts to the default.

Default 

delegated-prefix-length 64 minimum 48 maximum 64

Parameters 
bits —
Specifies the delegated prefix length, in bits.
Values—
48 to 127

 

prefix-length—
Specifies the minimum or maximum allowed prefix length, in bits.
Values—
48 to 127

 

exclude-prefix

Syntax 
[no] exclude-prefix ipv6-prefix/prefix-length
Context 
config>router>dhcp6>server>pool
config>service>vprn>dhcp6>server>pool
Description 

This command defines a prefix that to be excluded from available prefix in the pool for DHCP6. The typical use case is to exclude the interface address.

  1. A held lease is deleted if it got excluded by an exclude prefix.
  2. An exclude range can never exclude only a part of an existing lease. If for example a /63 PD is assigned, an exclude of /64 which belongs to this /63 cannot be configured.
  3. A single exclude prefix can never exclude a whole include prefix.
  4. When applying or removing an exclude prefix, the threshold stats are adjusted to reflect the actual address space and its usage.

The no form of this command removes the prefix that is to be excluded from available prefix in the pool.

Parameters 
ipv6-prefix/prefix-length—
Specifies an IPv6 prefix and prefix length.
Values—

ipv6-prefix

x:x:x:x:x:x:x:x (eight 16-bit pieces)

x:x:x:x:x:x:d.d.d.d

x - [0 to FFFF]H

d - [0 to 255]D

prefix-length

[0 to 128]

 

custom-option

Syntax 
custom-option option-number address [ipv6-address]
custom-option option-number domain [domain-string]
custom-option option-number hex hex-string
custom-option option-number string ascii-string
no custom-option option-number
Context 
config>router>dhcp6>server>defaults>options
config>router>dhcp6>server>pool>options
config>router>dhcp6>server>pool>prefix>options
config>service>vprn>dhcp6>server>pool>options
config>service>vprn>dhcp6>server>pool>prefix>options
config>service>vprn>dhcp6>server>pool>options
Description 

This command configures specific DHCP6 options. The options defined here can overrule options in the local user database.

The no form of the removes the custom option parameters from the configuration.

Parameters 
option-number—
Specifies up to four option numbers that the DHCP6 server uses to send the identification strings to the DHCP6 client.
Values—
1 to 254

 

ipv6-address—
Specifies the IPv6 address of a host.
domain-string—
Specifies the domain name, up to 127 characters.
hex-string—
Specifies the hex value of this option.
Values—
0x0 to 0xFFFFFFFF (up to 254 hex nibbles)

 

ascii-string—
Specifies the value of this option, up to 127 characters.

prefix

Syntax 
prefix ipv6-addr/prefix-length [failover {local | remote | access-driven}] [pd] [wan-host] [create]
no prefix ipv6-addr/prefix-length
Context 
config>router>dhcp6>server>pool
config>service>vprn>dhcp6>server>pool
Description 

This command allocates a prefix to a pool from which Prefix Delegation prefixes and or WAN addresses can be assigned for DHCP6.

The no form of this command removes the prefix parameters from the configuration.

Default 

prefix failover local

Parameters 
prefix ipv6-addr/prefix-length—
Specifies the prefix.
Values—

ipv6-address

x:x:x:x:x:x:x:x (eight 16-bit pieces)

x:x:x:x:x:x:d.d.d.d

x [0 to FFFF]H

d [0 to 255]D

prefix-length

[1 to 128]

 

failover {local | remote | access-driven}—
This command designates a prefix as local, remote, or access-driven. This is used when multi-chassis synchronization is enabled.
Values—
local — An IPv6 prefix designated as local is used for new lease grants or to renew the existing lease grants. Local prefix designation should be always paired with the remote designation of the same prefix on the peering node.
The IPv6 prefix configured as local on one node can only be configured as remote on the other node. No other combination is allowed between the two nodes for an IPv6 prefix that is configured as local.
The DHCPv6 relay could point to both IPv6 DHCP server addresses— the one hosting the local IPv6 prefix and the one hosting the corresponding remote IPv6 prefix. Under normal circumstances the new lease will always be allocated from the local IPv6 prefix while the leases can be renewed from either IPv6 prefix (local or remote). Under network failure, the remote IPv6 prefix can be taken over according to the intercommunication link state transitions and associated timers.
remote — A prefix designated as remote is used only to renew the existing DHCP leases. The new leases are assigned from it only after the maximum-client-lead-time and partner-down-delay time elapses.
To ensure faster takeover, the partner-down-delay can be set to 0 and the MCLT time can be ignored. Extra caution should be exercised when enabling this mode of operation, as described in the configuration guides.
The IPv6 prefix configured as remote on one node can only be configured as local on the other node. No other combination is allowed between the two nodes for an IP address ranges that is configured as remote.
access-driven — A prefix designated as access-driven is like local (a new prefix assignment as well as a renewal). However, as the prefix is shared between the redundant server pair, the following additional conditions should be met to avoid duplicate address allocations:
  1. A dual home access protection mechanism such as SRRP or MC-LAG must ensure a single active path from the
    DHCP client to the server.
  2. The DHCP relay should point to the local server only.

 

pd—
Specifies that this aggregate is used by IPv6 ESM hosts for DHCPv6 prefix-delegation.
wan-host—
Specifies that this aggregate is used by IPv6 ESM hosts for local addressing or by a routing gateway’s WAN interface.
create—
Keyword used to create the prefix configuration. The create keyword requirement can be enabled or disabled in the environment>create context.

depleted-event

Syntax 
[no] depleted-event
Context 
config>service>vprn>dhcp6>server>pool>prefix>thresholds>minimum-free
config>router>dhcp6>server>pool>prefix>thresholds>minimum-free
Description 

This command enables the system to send out a warning when the prefix with a configured length is no long available in the provisioned prefix.

For example:

prefix 2001:0:0:ffe0::/50 pd wan-host create
   thresholds
       minimum-free prefix-length 64
           depleted-event

With the above configuration, the system will send out a warning when there is no available /64 that can be allocated out of 2001:0:0:ffe0::/50.

The no form of this command disables the warnings.

thresholds

Syntax 
thresholds
Context 
config>router>dhcp6>server>pool
config>router>dhcp6>server>pool>prefix
config>service>vprn>dhcp6>server>pool
config>service>vprn>dhcp6>server>pool>prefix
Description 

This command enables the context to configure pool level thresholds.

Default 

thresholds

minimum-free

Syntax 
[no] minimum-free prefix-length [prefix-length]
Context 
config>service>vprn>dhcp6>server>pool>thresholds
config>router>dhcp6>server>pool>thresholds
Description 

This command creates a threshold for a given prefix length on the pool level. Up to 128 thresholds could be created. For example, with minimum-free prefix-length 64, then the usage of /64 prefix in the pool is counted.

There are two types of thresholds that could be defined at the pool level:

  1. Depleted — The system sends out a warning when the prefix with the configured length is no long available in the pool.
  2. Minimum free — A percentage-based threshold which represents the minimal available percentage of prefix with the configured length in the pool. The system will send out warning if the actual percentage is lower than the configured percentage

Configuring this command also enables the system stats collection for configure prefix length, which could be displayed with the show router router-id dhcp6 local-dhcp-server dhcp6-server-name pool-threshold-stats command.

The no form of this command removes the prefix-length from the configuration.

Parameters 
prefix-length—
Specifies the IPv6 prefix length.
Values—
1 to 128

 

depleted-event

Syntax 
[no] depleted-event
Context 
config>service>vprn>dhcp6>server>pool>thresholds>minimum-free
config>router>dhcp6>server>pool>thresholds>minimum-free
Description 

This command enables the system to send out warnings when the prefix with the configured length is no long available in the pool.

The no form of this command disables the warnings.

minimum

Syntax 
minimum percent [percent] [number [number]]
no minimum
Context 
config>service>vprn>dhcp6>server>pool>thresholds>minimum-free
config>router>dhcp6>server>pool>thresholds>minimum-free
Description 

This command specifies a percentage based threshold which represent the minimal available percentage of the prefix with configured length in the pool. The system will send out a warning if the actual percentage is lower than the configured percentage.

The no form of this command removes the percentage from the configuration.

Parameters 
percent—
Specifies the percentage of used prefixes with the minimum free threshold length in the pool compared to the number of provisioned prefixes.
Values—
0 to 100

 

number—
Specifies the number of used prefixes with the minimum free threshold length in the pool compared to the number of provisioned prefixes.
Values—
0 to 4294967295

 

minimum

Syntax 
minimum [percent [percent]] [number [number]]
no minimum
Context 
config>service>vprn>dhcp6>server>pool>prefix>thresholds>minimum-free
config>router>dhcp6>server> pool>prefix>thresholds>minimum-free
Description 

This command configures a percentage-based or number-based threshold which represents the minimal available percentage or number of the prefix with a configured length in the provisioned prefix. The system will send out a warning if the actual percentage or number is lower than the configured threshold.

For example:

prefix 2001:0:0:ffe0::/50 pd wan-host create
   thresholds
       minimum-free prefix-length 64
           minimum number 3
 

With the above configuration, the system will send a warning when the number of available /64 in prefix 2001:0:0:ffe0::/50 is less than 3.

The no form of this command removes the command parameters from the configuration.

Parameters 
percent—
Specifies the percentage of used prefixes with the minimum free threshold length in the pool compared to the number of provisioned prefixes.
Values—
0 to 100

 

number—
Specifies the number of prefixes.
Values—
0 to 4294967295

 

use-link-address

Syntax 
use-link-address [scope scope]
no use-link-address
Context 
config>router>dhcp6>server
config>service>vprn>dhcp6>server
Description 

This command configures the local pool selection for IPv6 address or prefix assignment for the configured link-address under relay configuration. The selected pool will contain a prefix covering the link-address. The scope option defines the scope for the match. With scope subnet, the prefix or address selection is limited to the prefix in the pool that covers the link-address. With scope pool, all the prefixes in the selected pool are eligible for assignment.

The no form of the reverts to the default.

Default 

scope subnet

Parameters 
scope—
Specifies the scope of the IP address selection.
Values—
subnet — Specifies that the prefix or address selection is limited to the prefix in the pool that covers the link address.
pool — Specifies that all prefixes in the selected pool are eligible for assignment.

 

user-ident

Syntax 
user-ident user-ident
no user-ident
Context 
config>router>dhcp6>server
config>service>vprn>dhcp6>server
Description 

This command configures the keys for identification of the DHCPv6 lease being held in the lease-database (for configured period after lease timeout). Subscriber requesting a lease via DHCPv6 that matches an existing lease based on this configured key is handed the matched prefix or address. This allows address and prefix “stickiness” for DHCPv6 assigned prefixes (IA_NA or PD).

The no form of the reverts to the default.

Default 

user-ident duid

Parameters 
user-ident—
Specifies the user identification method.
Values—
duid — Specifies the IPv6 DHCP unique identifier from DHCPv6.
interface-id — Specifies the IPv6 interface-id option.
interface-id-link-local — Specifies the interface-id and link-local address.

 

3.6.2.1.7. DHCP Service Commands

dhcp

Syntax 
dhcp
Context 
config>service>ies>if
config>service>ies>sub-if
config>service>ies>sub-if>grp-if
config>service>vpls>sap
config>service>vpls>spoke-sdp
config>service>vpls>mesh-sdp
config>service>vprn
config>service>vprn>if
config>service>vprn>sub-if
config>service>vprn>sub-if>grp-if
Description 

This command enables the context to configure DHCP parameters.

gi-address

Syntax 
gi-address ip-address [src-ip-address]
no gi-address
Context 
config>service>ies>if>dhcp
config>service>vprn>if>dhcp
config>service>vprn>sub-if>dhcp
config>service>ies>sub-if>grp-if>dhcp
config>service>ies>sub-if>dhcp
Description 

This command configures the gateway interface address for the DHCP relay. A subscriber interface can include multiple group interfaces with multiple SAPs. The GI address is needed, when the router functions as a DHCP relay, to distinguish between the different subscriber interfaces and potentially between the group interfaces defined.

By default, the GI address used in the relayed DHCP packet is the primary IP address of a normal IES interface. Specifying the GI address allows the user to choose a secondary address. For group interfaces a GI address must be specified under the group interface DHCP context or subscriber-interface DHCP context in order for DHCP to function.

The no form of this command reverts to the default.

Parameters 
ip-address—
Specifies the host IP address to be used for DHCP relay packets.
src-ip-address—
Specifies that this GI address is to be the source IP address for DHCP relay packets.

dhcp6

Syntax 
dhcp6
Context 
config>service>vpls>spoke-sdp
config>service>vpls>mesh-sdp
config>service>ies>interface
config>system
config>service>vprn
config>service>vprn>interface
config>service>vprn>sub-if
config>service>vprn>sub-if>grp-if
config>service>vprn>sub-if>grp-if>ipv6
config>service>ies>sub-if>grp-if>ipv6
config>service>ies>sub-if
config>service>ies>sub-if>grp-if
Description 

This command enables the context to configure DHCP6 parameters.

client-applications

Syntax 
client-applications [dhcp] [ppp]
no client-applications
Context 
config>service>vprn>sub-if>dhcp
config>service>ies>sub-if>dhcp
config>service>vprn>sub-if>grp-if>dhcp
config>service>ies>sub-if>grp-if>dhcp
config>service>vprn>sub-if>grp-if>ipv6>dhcp6>proxy
config>service>vprn>sub-if>grp-if>ipv6>dhcp6>relay
config>service>ies>sub-if>grp-if>ipv6>dhcp6>proxy
config>service>ies>sub-if>grp-if>ipv6>dhcp6>relay
config>service>vprn>sub-if>ipv6>dhcp6>proxy
config>service>vprn>sub-if>ipv6>dhcp6>relay
config>service>ies>sub-if>ipv6>dhcp6>proxy
config>service>ies>sub-if>ipv6>dhcp6>relay
Description 

This command enables DHCP relay and proxy-server for the configured client types.

The no form of this command reverts to the default.

Default 

dhcp

Parameters 
dhcp—
Enables IPoE clients to use the DHCP relay or proxy-server.
ppp—
Enables PPPoE clients to use the DHCP relay or proxy-server that PPPoE attempts to request an IP address for a PPPoE client from the DHCP server assigned to PPPoE node.

match-circuit-id

Syntax 
[no] match-circuit-id
Context 
config>service>ies>sub-if>grp-if>dhcp
config>service>vprn>sub-if>dhcp
config>service>vprn>sub-if>grp-if>dhcp
Description 

This command enables Option 82 circuit ID on relayed DHCP packet matching. For routed CO, the group interface DHCP relay process is stateful. When packets are relayed to the server the virtual router ID, transaction ID, SAP ID, and client hardware MAC address of the relayed packet are tracked.

When a response is received from the server the virtual router ID, transaction ID, and client hardware MAC address must be matched to determine the SAP on which to send the packet out. In some cases, the virtual router ID, transaction ID, and client hardware MAC address are not guaranteed to be unique.

When the match-circuit-id command is enabled this as part of the key is used to guarantee correctness in our lookup. This is only needed when dealing with an IP aware DSLAM that proxies the client hardware MAC address.

The no form of this command disables Option 82 circuit ID on relayed DHCP packet matching.

lease-populate

Syntax 
lease-populate [nbr-of-leases]
lease-populate [nbr-of-leases] l2-header [mac ieee-address]
no lease-populate
Context 
config>service>vpls>sap>dhcp
config>service>ies>if>dhcp
config>service>ies>sub-if>grp-if>dhcp
config>service>vprn>if>dhcp
config>service>vprn>sub-if>grp-if>dhcp
config>service>vprn>sub-if>dhcp
config>subscr-mgmt>msap-policy>vpls-only>dhcp
Description 

This command enables and disables dynamic host DHCPv4 lease state management for SAPs.

For VPLS, DHCP snooping must be explicitly enabled (using the snoop command) at all points where DHCP messages requiring snooping enter the VPLS instance (both from the DHCP server and from the subscribers). Lease state information is extracted from snooped DHCP ACK messages to populate lease state table entries for the SAP.

The optional number-of-entries parameter defines the number lease state table entries allowed.

  1. for this SAP in case of a VPLS service
  2. for this interface in case of an IES or VPRN interface
  3. for each SAP in case of an IES or VPRN group-interface
  4. for this interface in case of an IES or VPRN retail subscriber-interface

If number-of-entries is omitted, only a single entry is allowed. Once the maximum number of entries has been reached, subsequent lease state entries are not allowed and subsequent DHCP ACK messages are discarded.

The retained lease state information representing dynamic hosts may be used to:

  1. Populate a SAP based anti-spoof filter table to provide dynamic anti-spoof filtering. If the system is unable to populate the dynamic host information in the anti-spoof filter table on the SAP, the DHCP ACK message must be discarded without adding new lease state entry or updating an existing lease state entry.
  2. Populate the system’s ARP cache based on the arp-populate configuration. Applicable to IES and VPRN interfaces or group-interfaces.
  3. Populate managed entries into a VPLS forwarding database. VPLS forwarding database population is an implicit feature that automatically places the dynamic host’s MAC address into the VPLS FDB. When a dynamic host’s MAC address is placed in the lease state table, it will automatically be populated into the VPLS forwarding database associated with the SAP on which the host is learned. The dynamic host MAC address will override any static MAC entries using the same MAC and prevent dynamic learning of the MAC on another interface. Existing static MAC entries with the same MAC address as the dynamic host are marked as inactive but not deleted. If all entries in the lease state table associated with the MAC address are removed, the static MAC may be populated. New static MAC definitions for the VPLS instance may be created while a dynamic host exists associated with the static MAC address
  4. Generate dynamic ARP replies if arp-reply-agent is enabled. Applicable to VPLS service SAPs

The no form of this command reverts to the default.

Parameters 
nbr-of-leases—
Specifies the number of DHCPv4 leases allowed
l2-header—
Indicates a mode of operation where anti-spoof entry associated with the given DHCP state is created based on the MAC address from the Layer 2 header. The Layer 2 header flag is not set by default. This parameter is only applicable for group interfaces.
mac —
Specifies that the provisioned ieee-address will be used in the anti-spoofing entries for this SAP. The parameter may be changed mid-session. Existing sessions will not be re-programmed unless a tools perform command is issued for the lease. This parameter is only applicable for group interfaces.

neighbor-resolution

Syntax 
[no] neighbor-resolution
Context 
config>service>ies>if>ipv6>dhcp6-relay
config>service>vprn>if>ipv6>dhcp6-relay
Description 

This command enables neighbor resolution with DHCPv6 relay.

The no form of this command disables neighbor resolution.

option

Syntax 
[no] option
Context 
config>service>ies>if>ipv6>dhcp6-relay
config>service>vprn>if>ipv6>dhcp6-relay
Description 

This command enables the context to configure DHCPv6 relay information options.

The no form of this command disables DHCPv6 relay information options.

remote-id

Syntax 
[no] remote-id
Context 
config>service>ies>if>ipv6>dhcp6>option
config>service>vprn>if>ipv6>dhcp6>option
Description 

This command enables the sending of remote ID option in the DHCPv6 relay packet.

The client DHCP Unique Identifier (DUID) is used as the remote ID.

The no form of this command disables remote ID.

interface-id

Syntax 
interface-id [ascii-tuple]
interface-id ifindex
interface-id sap-id
interface-id string string
no interface-id
Context 
config>service>ies>if>ipv6>dhcp6>option
config>service>ies>if>ipv6>dhcp6-relay
config>service>vprn>if>ipv6>dhcp6>option
config>service>vprn>if>ipv6>dhcp6-relay
Description 

This command enables the sending of interface ID options in the DHCPv6 relay packet.

The no form of this command disables the sending of interface ID options in the DHCPv6 relay packet

Parameters 
ascii-tuple—
Specifies that the ASCII-encoded concatenated tuple is used which consists of the access-node-identifier, service-id, and interface-name, separated by “|”.
ifindex—
Specifies that the interface index is used. The If Index of a router interface can be displayed using the show>router>interface>detail command.
sap-id—
Specifies that the SAP identifier is used.
string—
Specifies that a string is used.

proxy-nd-policy

Syntax 
proxy-nd-policy policy-name [policy-name]
no proxy-nd-policy
Context 
config>service>ies>if>ipv6
Description 

This command configures a proxy neighbor discovery policy for the interface. This policy determines networks and sources for which proxy ND is attempted, when local proxy neighbor discovery is enabled.

The no form of this command reverts to the default value.

Parameters 
policy-name—
Specifies up to five the export route policy names. Allowed values are any string, up to 32 characters, composed of printable, 7-bit ASCII characters excluding double quotes. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

The specified name(s) must already be defined.

option

Syntax 
[no] option
Context 
config>service>ies>if>dhcp
config>service>ies>sub-if>dhcp
config>service>ies>sub-if>grp-if>dhcp
config>service>ies>sub-if>grp-if>ipv6>dhcp6
config>service>vpls>sap>dhcp
config>service>vpls>sap>dhcp6
config>service>vprn>if>dhcp
config>service>vprn>sub-if>dhcp
config>service>vprn>sub-if>grp-if>dhcp
config>service>vprn>sub-if>grp-if>ipv6>dhcp6
config>subscr-mgmt>msap-policy>vpls-only>dhcp
Description 

This command enables DHCP Option 82 (Relay Agent Information Option) parameters processing and enters the context for configuring Option 82 sub-options.

The no form of this command reverts to the default.

action

Syntax 
action dhcp-action
no action
Context 
config>service>ies>if>dhcp>option
config>service>ies>sub-if>grp-if>dhcp
config>service>vpls>sap>dhcp>option
config>service>vprn>if>dhcp>option
config>service>vprn>sub-if>grp-if>dhcp>option
config>subscr-mgmt>msap-policy>vpls-only>dhcp>option
Description 

This command configures the Relay Agent Information Option (Option 82) processing.

The no form of this command reverts to the default.

Default 

The default is to keep the existing information intact.

Parameters 
dhcp-action—
Specifies the DHCP Relay reforwarding policy action.
Values—
replace — In the upstream direction (from the user), the Option 82 field from the router is inserted in the packet (overwriting any existing Option 82 field). In the downstream direction (toward the user) the Option 82 field is stripped (in accordance with RFC 3046).
drop — The DHCP packet is dropped if an Option 82 field is present, and a counter is incremented.
keep — The existing information is kept in the packet and the router does not add any additional information. In the downstream direction the Option 82 field is not stripped and is forwarded towards the client.
In Vendor-Specific Options (VSOs) scenarios, the behavior is slightly different. Even with the action=keep, the router will insert his own VSO into the Option 82 field. This will only be done when the incoming message has already an Option 82 field.
If no Option 82 field is present, the router will not create the Option 82 field, then, no VSO will be added to the message.

 

circuit-id

Syntax 
circuit-id
circuit-id {ascii-tuple | if-index | sap-id | vlan-ascii-tuple}
circuit-id hex [hex-string]
no circuit-id
Context 
config>service>ies>if>dhcp>option
config>service>ies>sub-if>grp-if>dhcp>option
config>service>vpls>sap>dhcp>option
config>service>vprn>if>dhcp>option
config>service>vprn>sub-if>grp-if>dhcp>option
config>subscr-mgmt>msap-policy>vpls-only>dhcp>option
Description 

When enabled, the router sends an ASCII-encoded tuple in the circuit-id sub-option of the DHCP packet. This ASCII-tuple consists of the access-node-identifier, service-id, and SAP-ID, separated by “|”.

To send a tuple in the circuit ID, the action replace command must be configured in the same context.

If disabled, the circuit-id sub-option of the DHCP packet will be left empty.

The no form of this command reverts to the default.

Default 

circuit-id ascii-tuple

Parameters 
ascii-tuple—
Specifies that the ASCII-encoded concatenated tuple consisting of the access-node-identifier, service-id, and interface-name is used
ifindex—
Specifies that the interface index is used. The If Index of a router interface can be displayed using the command show>router>if>detail.
sap-id—
Specifies that the SAP identifier is used
vlan-ascii-tuple—
Specifies that the format will include VLAN-id and dot1p bits in addition to what is included in ascii-tuple already. The format is supported on dot1q and qinq ports only. Thus, when the Option 82 bits are stripped, dot1p bits will be copied to the Ethernet header of an outgoing packet.
hex-string—
Specifies the hex value of this option
Values—
0x0 to 0xFFFFFFFF...(up to 64 hex nibbles)

 

remote-id

Syntax 
remote-id
remote-id hex [hex-string]
remote-id mac
remote-id string string
no remote-id
Context 
config>service>ies>if>dhcp>option
config>service>ies>sub-if>grp-if>dhcp>option
config>service>vprn>sub-if>grp-if>dhcp>option
config>service>vpls>sap>dhcp>option
config>service>vprn>if>dhcp>option
config>subscr-mgmt>msap-policy>vpls-only>dhcp>option
Description 

This command specifies what information goes into the remote-id sub-option in the DHCP relay packet.

If disabled, the remote-id sub-option of the DHCP packet will be left empty.

The no form of this command reverts to the default.

Parameters 
mac—
Specifies the MAC address of the remote end is encoded in the sub-option
string—
Specifies the remote-id, up to 32 characters
hex-string—
Specifies the hex value of this option
Values—
0x0 to 0xFFFFFFFF...(up to 64 hex nibbles)

 

vendor-specific-option

Syntax 
[no] vendor-specific-option
Context 
config>service>vpls>sap>dhcp>option
config>service>ies>if>dhcp>option
config>service>vprn>if>dhcp>option
config>service>ies>sub-if>grp-if>dhcp>option
config>service>vprn>sub-if>grp-if>dhcp>option
config>subscr-mgmt>msap-policy>vpls-only>dhcp>option
Description 

This command enables the Nokia vendor-specific sub-option of the DHCP relay packet.

The no form of this command reverts to the default.

client-mac-address

Syntax 
[no] client-mac-address
Context 
config>service> ies>if>dhcp>option>vendor
config>service>vprn>if>dhcp>option>vendor
config>service>vprn>sub-if>grp-if>dhcp>option>vendor
config>service>ies>sub-if>grp-if>dhcp>option>vendor
config>subscr-mgmt>msap-policy>vpls-only>dhcp>option>vendor
Description 

This command enables the sending of the MAC address in the Nokia vendor-specific sub-option of the DHCP relay packet.

The no form of this command disables the sending of the MAC address in the Nokia vendor-specific sub-option of the DHCP relay packet.

sap-id

Syntax 
[no] sap-id
Context 
config>service>vpls>sap>dhcp>option>vendor
config>service>vprn>if>dhcp>option>vendor
config>service>vprn>sub-if>grp-if>dhcp>option>vendor
config>service>ies>sub-if>grp-if>dhcp>option>vendor
config>subscr-mgmt>msap-policy>vpls-only>dhcp>option>vendor
Description 

This command enables the sending of the SAP ID in the Nokia vendor-specific sub-option of the DHCP relay packet.

The no form of this command disables the sending of the SAP ID in the Nokia vendor-specific sub-option of the DHCP relay packet.

service-id

Syntax 
[no] service-id
Context 
config>service>vpls>sap>dhcp>option>vendor
config>service>vprn>if>dhcp>option>vendor
config>service>vprn>sub-if>grp-if>dhcp>option>vendor
config>service>ies>sub-if>grp-if>dhcp>option>vendor
Description 

This command enables the sending of the service ID in the Nokia vendor-specific sub-option of the DHCP relay packet.

The no form of this command disables the sending of the service ID in the Nokia vendor-specific sub-option of the DHCP relay packet.

string

Syntax 
[no] string text
Context 
config>service>vpls>sap>dhcp>option>vendor
config>service>vprn>if>dhcp>option>vendor
config>service>vprn>sub-if>grp-if>dhcp>option>vendor
config>service>ies>sub-if>grp-if>dhcp>option>vendor
config>subscr-mgmt>msap-policy>vpls-only>dhcp>option>vendor
Description 

This command specifies the string in the Nokia vendor-specific sub-option of the DHCP relay packet.

The no form of this command reverts to the default.

Parameters 
text—
Specifies a string that can be any combination of ASCII characters, up to 32 characters. If spaces are used in the string, enclose the entire string in quotation marks (“ “).

system-id

Syntax 
[no] system-id
Context 
config>service>vpls>sap>dhcp>option>vendor
config>service>vprn>if>dhcp>option>vendor
config>service>vprn>sub-if>grp-if>dhcp>option>vendor
config>service>ies>sub-if>grp-if>dhcp>option>vendor
config>subscr-mgmt>msap-policy>vpls-only>dhcp>option>vendor
Description 

This command specifies whether the system-id is encoded in the Nokia vendor-specific sub-option of Option 82.

The no form of this command reverts to the default.

proxy-server

Syntax 
proxy-server
Context 
config>service>ies>if>dhcp
config>service>ies>sub-if>grp-if>dhcp
config>service>vpls>sap>dhcp
config>service>vprn>sub-if>grp-if>dhcp
config>subscr-mgmt>msap-policy>vpls-only>dhcp>option>vendor
Description 

This command enables the context to configure DHCP proxy server parameters.

proxy-server

Syntax 
[no] proxy-server
Context 
config>service>vprn>sub-if>grp-if>ipv6>dhcp6
Description 

This command allows access to the DHCP6 proxy server context. Within this context, DHCP6 proxy server parameters of the group interface can be configured.

Default 

no proxy-server

emulated-server

Syntax 
emulated-server ip-address
no emulated-server
Context 
config>service>ies>if>dhcp>proxy-server
config>service>ies>sub-if>grp-if>dhcp>proxy-server
config>service>vpls>sap>dhcp>proxy-server
config>service>vprn>if>dhcp>proxy-server
config>service>ies>sub-if>grp-if>dhcp>proxy-server
config>service>vprn>sub-if>grp-if>dhcp>proxy-server
config>service>vprn>sub-if>ipv6>dhcp6>proxy
config>service>vprn>sub-if>grp-if>ipv6>dhcp6>proxy-server
config>subscr-mgmt>msap-policy>vpls-only>dhcp>option>proxy-server
Description 

This command configures the IP address which will be used as the DHCP server address in the context of the SAP. Typically, the configured address should be in the context of the subnet represented by the service.

The no form of this command reverts to the default setting. The local proxy server will not become operational without the emulated-server address being specified.

The no form of this command reverts to the default.

Parameters 
ip-address—
Specifies the emulated server’s IP address. This address must be unique within the subnet and specified in dotted decimal notation. Allowed values are IP addresses in the range 1.0.0.0 – 223.255.255.255 (with support of /31 subnets).

lease-time

Syntax 
lease-time [days days] [hrs hours] [min minutes] [sec seconds] [override]
no lease-time
Context 
config>service>vpls>sap>dhcp>proxy-server
config>service>ies>if>dhcp>proxy-server
config>service>ies>sub-if>grp-if>dhcp>proxy-server
config>service>vprn>if>dhcp>proxy
config>service>vprn>sub-if>grp-if>dhcp>proxy-server
config>service>ies>sub-if>grp-if>wpp
config>service>vprn>sub-if>grp-if>wpp
config>subscr-mgmt>msap-policy>vpls-only>dhcp>option>proxy-server
Description 

This command defines the length of lease-time that will be provided to DHCP clients. By default, the local-proxy-server always makes use of the lease time information provide by either a RADIUS or DHCP server.

The no form of this command disables the use of the lease-time command. The local-proxy-server will use the lease-time offered by either a RADIUS or DHCP server.

Default 

7 days 0 hours 0 seconds

Parameters 
override—
Specifies that the local-proxy-server will use the configured lease-time information to provide DHCP clients
days—
Specifies the number of days that the given IP address is valid.
Values—
0 to 3650

 

hours—
Specifies the number of hours that the given IP address is valid.
Values—
0 to 23

 

minutes—
Specifies the number of minutes that the given IP address is valid.
Values—
0 to 59

 

seconds—
Specifies the number of seconds that the given IP address is valid.
Values—
0 to 59

 

pool-name

Syntax 
[no] pool-name
Context 
config>service>vprn>if>dhcp>option>vendor
config>service>vprn>sub-if>grp-if>dhcp>option>vendor
config>service>ies>if>dhcp>option>vendor
config>service>ies>sub-if>grp-if>dhcp>option>vendor
Description 

This command sends the pool name in the Nokia vendor specific sub-option of the DHCP relay packet.

The no form of this command reverts to the default.

override-slaac

Syntax 
[no] override-slaac
Context 
config>service>vprn>sub-if>ipv6>dhcp6
config>service>ies>sub-if>ipv6>dhcp6
config>service>vprn>sub-if>grp-if>ipv6>dhcp6
config>service>ies>sub-if>grp-if>ipv6>dhcp6
Description 

This command allows a DHCP IA_NA address to override and replace a host existing SLAAC address. When this feature is enabled, a subscriber SLAAC address is removed once the DHCP IA_NA address assignment is completed. If used with conjunction with the allow-multiple-wan-address command, the DHCP IA_NA address will also override the SLAAC address.

pd-managed-route

Syntax 
pd-managed-route [next-hop {ipv4 | ipv6}]
no pd-managed-route
Context 
config>service>vprn>sub-if>ipv6>dhcp6
config>service>ies>sub-if>ipv6>dhcp6
config>service>vprn>sub-if>grp-if>ipv6>dhcp6
config>service>ies>sub-if>grp-if>ipv6>dhcp6
Description 

This command enables DHCP IA-PD (delegated prefix) to be modeled as managed (framed) route instead of as a subscriber-host. Antispoof filtering for the subscriber host associated with the IA-PD route must be set to nh-mac. The subscriber specific parameters (such as sla-profile or sub-profile) will be ignored during the authentication phase because IA-PD is not modeled as a subscriber host. Other subscriber host-specific functions (for example, host overrides via CoA or host accounting) are not possible with a PD as the managed route.

By default, or when configured with the next-hop ipv6 parameter, the next-hop for PD managed route is an IPv6 WAN sub-host (DHCP IA-NA or SLAAC) with the same mac address as the one in the DHCP lease state for the managed IA-PD. The DHCP IA-NA next-hop host will always override the SLAAC next-hop host if both are available. If the IPv6 next-hop is not present when the framed IA-PD is instantiated, the IA-PD will be set up but the PD managed route will not be installed in the IPv6 route table and the DHCPv6 lease state for the IA-PD will have the managed route status (DHCP6 MRt Status) set to “noNextHop”.

When configured with the next-hop ipv4 parameter the next-hop for PD managed route is a DHCPv4 sub-host that belongs to the same IPoE session or PPPoE session. For IPoE, ipoe-session must be enabled on the group-interface. If ipoe-session is disabled, an IPv4 next-hop will not be found. If the IPv4 next-hop is not found or not present at the time when the framed IA-PD is instantiated, the IA-PD will be set up but the PD managed route will not be installed in the IPv6 route table. In this case, the DHCPv6 lease state for the IA-PD will have the managed route status (DHCP6 MRt Status) set to noNextHop.

Note:

IPv6 filters, QoS IPv6 criteria, and IPv6 multicast are not supported for DHCPv6 IA-PD as managed route pointing to an IPv4 subscriber host as next-hop.

The DHCP IA-PD modeled as a route is displayed differently than regular subscriber hosts in show commands related to subscriber host state. The PD managed route is always shown directly below the host it is using as the next hop. The forwarding status of the PD managed route is also shown, where (N) indicate that the PD managed route is not forwarding. In addition, DHCP IA-PD route is displayed as a managed route for the corresponding IPv6 subscriber host (DHCP IA-NA or SLAAC) or DHCPv4 subscriber host.

DHCP IA-PD information for managed IA-PD route is still maintained in the DHCPv6 lease state.

The no form of this command reverts to the default.

Parameters 
next-hop—
Specifies the next-hop type for the DHCP IA-PD managed route
Values—
ipv4 - The next-hop for PD managed route is a DHCPv4 sub-host that belongs to the same IPoE session (based on the IPoE session key which is sap-mac by default). IPoE session must be enabled on the group-interface.
ipv6 - The next-hop for PD managed route is an IPv6 WAN sub-host (DHCP IA-NA or SLAAC) with the same MAC address as the one in the DHCP lease state for the managed IA-PD. This is the default when no next-hop is specified.

 

enable-ingress-stats

Syntax 
[no] enable-ingress-stats
Context 
config>service>ies>sub-if>grp-if
config>service>vprn>sub-if>grp-if
Description 

This command enables the collection of ingress interface IP stats. This command is only applicable to IP statistics, and not to uRPF statistics.

If enabled, then the following statistics are collected:

  1. IPv4 offered packets
  2. IPv4 offered octets
  3. IPv6 offered packets
  4. IPv6 offered octets

Octet statistics for IPv4 and IPv6 bytes at IP interfaces include the Layer 2 frame overhead.

The no form of the reverts to the default.

duid

Syntax 
duid duid [iaid iaid]
no duid
Context 
config>service>ies>if>ipv6>dhcp6>pfx-delegate>prefix
Description 

This command configures the DHCP Unique Identifier (DUID) of the DHCP client.

The no form of this command reverts to the default.

Default 

duid 2

Parameters 
duid—
Specifies the ID of the requesting router, up to a maximum of 128 hex values. If set to a non-zero value the prefix defined will only be delegated to this router. If set to zero, the prefix will be delegated to any requesting router.
iaid—
Specifies the identity association identification (IAID) from the requesting router that needs to match to delegate the prefix defined in this row. If set to 0 no match on the received IAID is done.
Values—
1 to 4294967295

 

preferred-lifetime

Syntax 
preferred-lifetime seconds
preferred-lifetime infinite
no preferred-lifetime
Context 
config>service>ies>if>ipv6>dhcp6>pfx-delegate>prefix
config>service>ies>sub-if>ipv6>dhcp6>proxy
config>service>ies>sub-if>grp-if>ipv6>dhcp6>proxy
config>service>vprn>if>ipv6>dhcp6>pfx-delegate>prefix
config>service>vprn>sub-if>ipv6>dhcp6>proxy
config>service>vprn>sub-if>grp-if>ipv6>dhcp6>proxy
config>service>vprn>dhcp6>server>pool>prefix
Description 

This command configures the IPv6 prefix/mask preferred life time. The preferred-lifetime value cannot be bigger than the valid-lifetime value.

The no form of this command reverts to the default value.

Default 

preferred-lifetime 604800 (7 days)

Parameters 
seconds—
Specifies the preferred lifetime in seconds
Values—
1 to 4294967294

 

infinite—
Specifies that the remaining time will never expire. The value 4294967294 is interpreted as infinite.

preferred-lifetime

Syntax 
preferred-lifetime seconds
preferred-lifetime infinite
no preferred-lifetime
Context 
config>service>ies>sub-if>grp-if>ipv6>rtr-adv>pfx-opt
config>service>vprn>sub-if>grp-if>ipv6>rtr-adv>pfx-opt
config>service>ies>sub-if>ipv6>rtr-adv>pfx-opt
config>service>vprn>sub-if>ipv6>rtr-adv>pfx-opt
config>router>dhcp6>server>pool>prefix>options
config>service>vprn>dhcp6>server>pool>prefix>options
Description 

This command specifies the remaining time for this prefix to be preferred, thus time until deprecation.

The no form of this command reverts to the default.

Default 

preferred-lifetime 3600

Parameters 
seconds—
Specifies the time for the prefix to remain preferred on this group-interface in seconds
Values—
0 to 4294967295

 

infinite—
Specifies that the remaining time will never expire. The value 4294967295 is interpreted as infinite.

preferred-lifetime

Syntax 
preferred-lifetime [days days] [hrs hours] [min minutes] [sec seconds]
no preferred-lifetime
Context 
config>router>dhcp6>server>pool>prefix>options
Description 

This command specifies the remaining time for this prefix to be preferred, thus time until deprecation.

The no form of this command reverts to the default.

Default 

preferred-lifetime 3600

Parameters 
time—
Specifies the preferred lifetime.
Values—

days

0 to 3650

hours

0 to 23

minutes

0 to 59

seconds

0 to 59

 

valid-lifetime

Syntax 
valid-lifetime infinite
valid-lifetime [days days] [hrs hours] [min minutes] [sec seconds]
no valid-lifetime
Context 
config>service>vprn>dhcp6>local-dhcp-server>pool>prefix
config>router>dhcp6>server>pool>prefix
config>service>vprn>sub-if>grp-if>ipv6>dhcp6>proxy-server
Description 

This command configures the valid lifetime for the IPv6 prefix or address in the option.

The no form of this command reverts to the default.

Default 

valid-lifetime days 1

Parameters 
infinite—
Sets the valid lifetime to infinite value.
valid-lifetime—
Specifies the valid lifetime
Values—

days days

0 to 49710

hrs hours

0 to 23

min minutes

0 to 59

sec seconds

0 to 5

 

python-policy

Syntax 
python-policy python-name
no python-policy
Context 
config>service>ies>if>dhcp
config>service>vprn>if>dhcp
config>service>ies>sub-if>dhcp
config>service>vprn>sub-if>dhcp
Description 

This command specifies the python-policy to be used for DHCPv4 relay.

The no form of this command reverts to the default.

Parameters 
python-name—
Specifies the name of an existing python script, up to 32 characters.

python-policy

Syntax 
python-policy python-name
no python-policy
Context 
config>service>vprn>sub-if
config>service>vprn>sub-if>ipv6>dhcp6
config>service>ies>sub-if>ipv6>dhcp6
config>service>ies>if>ipv6>dhcp6-relay
config>service>vprn>if>ipv6>dhcp6-relay
config>service>ies>sub-if>dhcp
config>service>vprn>sub-if>dhcp
config>service>ies>sub-if>grp-if>dhcp
config>service>vprn>sub-if>grp-if>dhcp
config>service>ies>sub-if>grp-if>pppoe
config>service>vprn>sub-if>grp-if>pppoe
config>service>vprn>sub-if>ipv6>dhcp6>proxy
config>service>vprn>sub-if>grp-if>ipv6>dhcp6>proxy-server
Description 

This command specifies the python-policy to be used for DHCPv6 relay.

The no form of this command reverts to the default.

Parameters 
python-name—
Specifies the name of an existing python script, up to 32 characters.

relay

Syntax 
[no] relay
Context 
config>service>vprn>sub-if>grp-if>ipv6>dhcp6
config>service>ies>sub-if>grp-if>ipv6>dhcp6
config>service>vprn>sub-if>ipv6>dhcp6
config>service>ies>sub-if>ipv6>dhcp6
Description 

This command enables the context to configure DHCPv6 relay parameters for this interface.

snoop

Syntax 
[no] snoop
Context 
config>service>vpls>sap>dhcp
config>service>vpls>spoke-sdp>dhcp
config>service>vpls>mesh-sdp>dhcp
config>service>vprn>if>dhcp>option
config>service>vpls>sap>dhcp6
config>service>vprn>nw-if>dhcp
Description 

This command enables snooping of DHCP or DHCP6 messages on the SAP or SDP. Enabling DHCP or DHCP6 snooping on interfaces (SAPs and SDP bindings) is required where DHCP or DHCP6 messages important to lease state table population are received, or where Option 82 information is to be inserted. This includes interfaces that are in the path to receive messages from either DHCP or DHCP6 servers or from subscribers.

The no form of this command disables DHCP or DHCP6 snooping on the specified SAP or SDP binding.

dhcp-user-db

Syntax 
dhcp-user-db local-user-db-name
no dhcp-user-db
Context 
config>service>vpls>sap
Description 

This command enabled access to LUDB for DHCPv4 hosts under the capture SAP. The name of this local user database must match the name of local user database configured under the config>service>vprn/ies>sub-if>group-if>dhcp hierarchy.

Parameters 
local-user-db—
Specifies the name of the local-user-database, up to 32 characters.

dhcp-python-policy

Syntax 
dhcp-python-policy policy-name
no dhcp-python-policy
Context 
config>service>vpls>sap
Description 

This command specifies the name of the Python policy. The Python policy is created in the config>python>python-policy name context.

The no form of this command reverts to the default.

Parameters 
policy-name—
Specifies a Python policy name, up to 32 characters

dhcp6

Syntax 
[no] dhcp6
Context 
config>service>ies>sub-if>grp-if>ipv6
config>service>vprn>sub-if>grp-if>ipv6
config>service>vpls>sap
Description 

This command enables the context to configure DHCP6 parameters. Within this context, DHCP6 parameters can be configured.

option

Syntax 
[no] option
Context 
config>service>vprn>sub-if>grp-if>ipv6
Description 

This command enters the context to configure DHCPv6 relay information options.

The no form of this command disables DHCPv6 relay information options.

interface-id

Syntax 
interface-id [ascii-tuple]
interface-id ifindex
interface-id sap-id
interface-id string string
no interface-id
Context 
config>service>vprn>sub-if>grp-if>ipv6>dhcp6>option
Description 

This command enables the sending of interface ID options in the DHCPv6 relay packet.

The no form of this command disables the sending of interface ID options in the DHCPv6 relay packet

Parameters 
ascii-tuple—
Specifies that the ASCII-encoded concatenated tuple will be used which consists of the access-node-identifier, service-id, and interface-name, separated by “|”.
ifindex—
Specifies that the interface index will be used (the If Index of a router interface can be displayed using the command show>router>if>detail).
sap-id—
Specifies that the SAP identifier will be used.
string—
Specifies a string, up to 32 characters long, composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed between double quotes.

remote-id

Syntax 
remote-id
remote-id mac
remote-id string [string]
no remote-id
Context 
config>service>ies>if>ipv6>dhcp6>option
config>service>vprn>if>ipv6>dhcp6>option
config>service>vpls>sap>dhcp6
config>service>vprn>sub-if>grp-if>ipv6>dhcp6>option
Description 

This command enables the sending of remote ID option in the DHCPv6 relay packet.

The client DHCP Unique Identifier (DUID) is used as the remote ID.

The no form of this command disables the sending of remote ID option in the DHCPv6 relay packet.

dhcp6-user-db

Syntax 
dhcp6-user-db local-user-db
no dhcp6-user-db
Context 
config>service>vpls>sap
Description 

This command enabled access to LUDB for DHCPv6 hosts under the capture SAP. The name of this LUDB must match the name of the LUDB configured under the config>service>vprn/ies>sub-if>grp-if>dhcp hierarchy.

The no form of this command reverts to the default.

Parameters 
local-user-db —
Specifies the name of the local-user-database, up to 32 characters

ppp-user-db

Syntax 
ppp-user-db local-user-db-name
no ppp-user-db
Context 
config>service>vpls
Description 

This command enabled access to LUDB for PPPoE and PPPoEoA v4and v6 hosts under the capture SAP. The name of this local user database must match the name of local user database configured under the config>service>vprn/ies>sub-if>grp-if>pppoe hierarchy.

The no form of this command reverts to the default.

Parameters 
local-user-db—
Specifies the name of the local-user-database, up to 256 characters

pppoe-user-db

Syntax 
pppoe-user-db local-user-db-name
no pppoe-user-db
Context 
config>service>vpls
Description 

This command enabled access to LUDB for PPPoE and PPPoEoA v4and v6 hosts under the capture SAP. The name of this LUDB must match the name of the LUDB configured under the config>service>vprn/ies>sub-if>grp-if>pppoe hierarchy.

The no form of this command reverts to the default.

Parameters 
local-user-db —
Specifies the name of the local user database, up to 256 characters

filter

Syntax 
filter filter-id
no filter
Context 
config>service>ies>sub-if>grp-if>dhcp
config>service>vprn>sub-if>grp-if>dhcp
Description 

This command assigns a DHCP filter to the group-interface. This feature is used where the SR 7750 is the second DHCP relay or where DHCP messages are snooped for subscriber management. The filter can be used to bypass host creation, drop DHCP message, or perform no action.

The no form of this command reverts to the default.

Parameters 
filter-id—
Specifies the DHCP filter ID for this interface
Values—
1 to 65535

 

filter

Syntax 
filter filter-id
no filter
Context 
config>service>ies>sub-if>grp-if>dhcp6
config>service>vprn>sub-if>grp-if>dhcp6
Description 

This command assigns a DHCP6 filter to the group interface. This feature is used where the SR 7750 is the second DHCP6 relay or where DHCP6 messages are snooped for subscriber management. The filter can be used to bypass host creation, drop DHCP6 message, or perform no action.

The no form of this command reverts to the default.

Parameters 
filter-id—
Specifies the DHCP6 filter ID for this interface
Values—
1 to 65535

 

anti-spoof

Syntax 
anti-spoof type
no anti-spoof
Context 
config>service>ies>sap
config>service>vpls>sap
config>service>ies>sub-if>gr-if>pppoe
config>service>ies>ies>sub-if>gr-if>sap
config>service>ies>ies>sub-if>gr-if>sap-parameters
config>service>vprn>sub-if>grp-if>pppoe
config>service>vprn>sub-if>grp-if>sap
config>service>vprn>sub-if>grp-if>sap-parameters
config>subscr-mgmt>msap-policy>ies-vprn-only-sap-parameters
config>service>vpls>sap
Description 

This command enables anti-spoof filtering and optionally changes the anti-spoof matching type for the SAP.

The type of anti-spoof filtering defines what information in the incoming packet is used to generate the criteria to lookup an entry in the anti-spoof filter table. The type parameter (ip, mac, ip-mac) defines the anti-spoof filter type enforced by the SAP when anti-spoof filtering is enabled.

The no form of this command disables anti-spoof filtering on the SAP.

Parameters 
type—
Specifies the anti-spoof filtering type for this SAP
Values—
ip — Specifies SAP anti-spoof filtering to use only the source IP address in its lookup. If a static host exists on the SAP without an IP address specified, the anti-spoof ip command fails.
mac — Specifies SAP anti-spoof filtering to use only the source MAC address in its lookup. If a static host exists on the SAP without a specified MAC address, the anti-spoof mac command fails.
ip-mac — Specifies SAP anti-spoof filtering to use both the source IP address and the source MAC address in its lookup.

 

relay-plain-bootp

Syntax 
[no] relay-plain-bootp
Context 
config>service>ies>if>dhcp
config>service>vprn>if>dhcp
Description 

This command enables the relaying of plain BOOTP packets.

The no form of this command disables the relaying of plain BOOTP packets.

relay-proxy

Syntax 
relay-proxy [release-update-src-ip] [siaddr-override ip-address]
no relay-proxy
Context 
config>service>ies>if>dhcp
config>service>ies>sub-if>dhcp
config>service>ies>sub-if>grp-if>dhcp
config>service>vprn>if>dhcp
config>service>vprn>sub-if>dhcp
config>service>vprn>sub-if>grp-if>dhcp
Description 

This command enables the DHCPv4 relay proxy function on the interface. The command has no effect when no dhcp servers are configured (DHCPv4 relay not configured). By default, unicast DHCPv4 release messages are forwarded transparently.

A relay proxy enhances the relay such that it also relays unicast client DHCPv4 REQUEST messages (lease renewals).

  1. In the upstream direction, update the source IP address and add the gateway IP address (gi-address) field before sending the message to the intended DHCP server (the message is not broadcasted to all configured DHCP servers.
  2. In the downstream direction, remove the gi-address and update the destination IP address to the address of the yiaddr (your IP address) field.

The optional release-update-src-ip parameter updates the source IP address of a DHCP RELEASE message with the address used for relayed DHCPv4 messages.

The optional siaddr-override ip-address parameter enables DHCP server IP address hiding towards the client. This parameter requires that lease-populate is enabled on the interface. The DHCP server ip address is required for the address hiding function and is stored in the lease state record. The client interacts with the relay proxy as if it is the DHCP server. In all DHCP messages to the client, the value of following header fields and DHCP options containing the DHCP server IP address is replaced with the configured <ip-address>:

  1. the “source IP address” field in the IP DHCPv4 packet header
  2. the “siaddr” field in the DHCPv4 header if not equal to zero in the message received from the server
  3. the Server Identification option (DHCPv4 option 54) if present in the original server message
  4. the source IP address field in the IP packet header

DHCP OFFER selection during initial binding is done in the relay-proxy. Only the first DHCP OFFER message is forwarded to the client. Subsequent DHCP OFFER messages from different servers are silently dropped.

Parameters 
release-update-src-ip—
Updates the source IP address of a DHCP RELEASE message with the address used for relayed DHCPv4 messages.
ip-address—
Enables DHCPv4 server address hiding towards the DHCPv4 client and activates DHCPv4 OFFER selection in case multiple DHCP servers are configured. The ip-address can be any local address in the same routing instance. If DHCP relay lease-split is enabled, siaddr-override ip-address has priority over the emulated-server ip-address configured in the proxy-server and will be used as the source IP address.

server

Syntax 
server ipv6z-address [ipv6z-address]
no server [ipv6z-address]
Context 
config>service>ies>if>ipv6>dhcp6
Description 

This command specifies a list of servers where DHCP6 requests will be forwarded. The list of servers can be entered as either IP addresses or fully qualified domain names. There must be at least one server specified for DHCP6 relay to work. If there are multiple servers then the request is forwarded to all servers in the list.

The no form of this command reverts to the default.

Parameters 
ipv6z-address—
Specifies up to eight non-global IPv4 addresses including a zone index as defined by the InetAddressIPv4z textual convention
Values—

ipv6-address:

x:x:x:x:x:x:x:x (eight 16-bit pieces)

x:x:x:x:x:x:d.d.d.d

x: [0 to FFFF]H

d: [0 to 255]D

 

server

Syntax 
server server1 [server2]
Context 
config>service>ies>if>dhcp
config>service>vprn>if>dhcp
config>service>ies>sub-if>grp-if>dhcp
Description 

This command specifies a list of servers where requests will be forwarded. The list of servers can be entered as either IP addresses or fully qualified domain names. There must be at least one server specified for DHCP relay to work. If there are multiple servers then the request is forwarded to all servers in the list.

There can be a maximum of 8 DHCP servers configured.

The no form of this command reverts to the default.

Parameters 
server—
Specifies up to eight DHCP server IP addresses

virtual-subnet

Syntax 
[no] virtual-subnet
Context 
config>service>ies>sub-if>dhcp
config>service>vprn>sub-if>dhcp
Description 

This command enables a virtual-subnet for DHCPv4 hosts under the subscriber-interface. With this command configured, the system will snoop and record the default router address in the DHCP ACK message for the DHCPv4 ESM host. The system could answer ping or traceroute request even if the default router address is not configured on the subscriber-interface.

The no form of this command reverts to the default.

local-address-assignment

Syntax 
local-address-assignment
Context 
config>service>ies>sub-if
config>service>vprn>sub-if
config>service>ies>sub-if>grp-if
config>service>vprn>sub-if>grp-if
Description 

This command enables the context to configure local address assignment parameters.

client-application

Syntax 
client-application [ppp-v4] [ipoe-v4]
no client-application
Context 
config>service>ies>sub-if>grp-if>local-address-assignment
config>service>ies>sub-if>local-address-assignment
config>service>vprn>sub-if>grp-if>local-address-assignment
config>service>vprn>sub-if>local-address-assignment
Description 

This command enables local DHCP Server pool management for PPPoXv4 clients. A pool of IP addresses can be shared between IPoE clients that rely on DHCP protocol (lease renewal process) and PPPoX clients where address allocation is not dependent on DHCP messaging but instead an IP address allocation within the pool is tied to the PPPoX session.

default-pool

Syntax 
default-pool pool-name
no default-pool
Context 
config>service>ies>sub-if>grp-if>local-address-assignment
config>service>ies>sub-if>local-address-assignment
config>service>vprn>sub-if>grp-if>local-address-assignment
config>service>vprn>sub-if>local-address-assignment
Description 

This command references a default DHCP address pool for local PPPoX pool management in case that the pool-name is not returned via Radius or LUDB.

Parameters 
pool-name—
Specifies the name of the local DHCP server pool.

server

Syntax 
server server-name
no server
Context 
config>service>ies>sub-if>grp-if>local-address-assignment
config>service>ies>sub-if>local-address-assignment
config>service>vprn>sub-if>grp-if>local-address-assignment
config>service>vprn>sub-if>local-address-assignment
Description 

This command designates a local DHCPv4 server for local pools management where IPv4 addresses for PPPoXv4 clients will be allocated without the need for the internal DHCP relay-agent. Those addresses will be tied to PPPoX sessions and they will be de-allocated when the PPPoX session is terminated.

Parameters 
server-name—
Specifies the name of the local DHCP server.

relay-plain-bootp

Syntax 
[no] relay-plain-bootp
Context 
config>service>vprn>if>dhcp
Description 

This command enables the relaying of plain BOOTP packets.

The no form of this command disables the relaying of plain BOOTP packets.

use-arp

Syntax 
[no] use-arp
Context 
config>service>vprn>if>dhcp
config>service>ies>if>dhcp
Description 

This command enables the use of ARP to determine the destination hardware address.

The no form of this command disables the use of ARP to determine the destination hardware address.

user-db

Syntax 
user-db local-user-db-name
no user-db
Context 
config>service>ies>sub-if>grp-if>pppoe
config>service>vprn>sub-if>grp-if>pppoe
config>service>ies>sub-if>grp-if>ppp
config>service>vprn>sub-if>grp-if>ppp
Description 

This command configures the local user database to use for PPP PAP/CHAP authentication

The no form of this command reverts to the default.

Parameters 
local-user-db-name—
Specifies the local user database name, up to 32 characters

trusted

Syntax 
[no] trusted
Context 
config>service>ies>if>dhcp
config>service>vprn>if>dhcp
config>service>ies>sub-if>grp-if>dhcp
Description 

This command enables relaying untrusted packets. According to RFC 3046, DHCP Relay Agent Information Option, a DHCP request where the giaddr is 0.0.0.0 and which contains an Option 82 field in the packet, should be discarded, unless it arrives on a “trusted” circuit. If the trusted mode is enabled on an IP interface, the Relay Agent (the router) modifies the request's giaddr to be equal to the ingress interface and forward the request.

Note:

This behavior only applies when the action in the Relay Agent Information Option is keep. In the case where the option 82 field is being replaced by the Relay Agent (action = replace), the original Option 82 information is lost anyway, and thus, there is no reason for enabling the trusted option.

The no form of this command reverts to the default.

ipv6

Syntax 
ipv6
Context 
config>service>ies>if>
config>service>ies>sub-if>grp-if
config>service>vprn>if>
config>service>vprn>sub-if>grp-if
Description 

This command enables the context to configure IPv6 parameters for the interface.

address

Syntax 
address ipv6-address/prefix-length [eui-64]
no address ipv6-address/prefix-length
Context 
config>service>ies>if>ipv6
config>service>vprn>if>ipv6
Description 

This command assigns an IPv6 address to the IES interface.

The no form of this command reverts to the default.

Parameters 
ipv6-address/prefix-length—
Specifies the IPv6 address on the interface
Values—

ipv6-address

x:x:x:x:x:x:x:x (eight 16-bit pieces)

x:x:x:x:x:x:d.d.d.d

x [0 to FFFF]H

d [0 to 255]D

prefix-length

1 to 128

 

eui-64—
When the eui-64 keyword is specified, a complete IPv6 address from the supplied prefix and 64-bit interface identifier is formed. The 64-bit interface identifier is derived from MAC address on Ethernet interfaces. For interfaces without a MAC address, for example ATM interfaces, the Base MAC address of the chassis is used.

allow-multiple-wan-addresses

Syntax 
[no] allow-multiple-wan-addresses
Context 
config>service>ies>sub-if>ipv6
config>service>ies>sub-if>grp-if>ipv6
config>service>vprn>sub-if>ipv6
config>service>vprn>sub-if>grp-if>ipv6
Description 

This command enables host to have two WAN addresses, one from DHCP IA_NA and one from SLAAC assignment.

The no form of this command reverts to the default.

auto-reply

Syntax 
[no] auto-reply
Context 
config>service>vprn>sub-if>grp-if>ipv6
config>service>ies>sub-if>grp-if>ipv6
Description 

This command assists IP-only static hosts to resolve their default gateway and MAC. By default, the BNG anti-spoof filter drops packets from unknown hosts. The auto-reply features first allow hosts to resolve their default gateway and afterwards allow them to forward traffic. Using the data traffic, the BNG can utilize the data-trigger mechanism to learn the host’s MAC and populate the full IP+MAC static host entry.

The no form of this command reverts to the default.

neighbor-solicitation

Syntax 
[no] neighbor-solicitation
Context 
config>service>vprn>sub-if>grp-if>ipv6>auto-reply
config>service>ies>sub-if>ipv6>auto-reply
Description 

This command enables auto-reply for neighbor solicitation.

The no form of this command disables auto-reply.

Default 

neighbor-solicitation

router-solicitation

Syntax 
[no] router-solicitation
Context 
config>service>vprn>sub-if>grp-if>ipv6>auto-reply
config>service>ies>sub-if>grp-if>ipv6>auto-reply
Description 

This command enables auto-reply router solicitation.

The no form of this command disables router-solicitation.

Default 

router-solicitation

dhcp6-relay

Syntax 
[no] dhcp6-relay
Context 
config>service>ies>if>ipv6
config>service>vprn>if>ipv6
Description 

This command enables the context to configure DHCPv6 relay parameters for the interface.

action

Syntax 
action {replace | drop | keep}
no action
Context 
config>service>vprn>if>dhcp>option
config>service>vprn>sub-if>grp-if>dhcp>option
Description 

This command configures the processing required when the SR-Series receives a DHCP request that already has a Relay Agent Information Option (Option 82) field in the packet.

The no form of this command returns the system to the default value.

Default 

action keep — Per RFC 3046, DHCP Relay Agent Information Option, section 2.1.1, Reforwarded DHCP requests. The default is to keep the existing information intact. The exception to this is if the giaddr of the received packet is the same as the ingress address on the router. In that case the packet is dropped and an error is logged.

Parameters 
replace—
In the upstream direction (from the user), the existing Option 82 field is replaced with the Option 82 field from the router. In the downstream direction (towards the user) the Option 82 field is stripped (in accordance with RFC 3046).
drop—
The packet is dropped, and an error is logged
keep—
The existing information is kept in the packet and the router does not add any additional information. In the downstream direction the Option 82 field is not stripped and is sent on towards the client.

The behavior is slightly different in case of Vendor Specific Options (VSOs). When the keep parameter is specified, the router will insert his own VSO into the Option 82 field. This will only be done when the incoming message has already an Option 82 field.

If no Option 82 field is present, the router will not create the Option 82 field. In this in that case, no VSO will be added to the message.

match-circuit-id

Syntax 
[no] match-circuit-id
Context 
config>service>vprn>sub-if>grp-if>dhcp
config>service>ies>sub-if>grp-if>dhcp
Description 

This command enables Option 82 circuit ID on relayed DHCP packet matching. For routed CO, the group interface DHCP relay process is stateful. When packets are relayed to the server the virtual router ID, transaction ID, SAP ID, and client hardware MAC address of the relayed packet are tracked.

When a response is received from the server the virtual router ID, transaction ID, and client hardware MAC address must be matched to determine the SAP on which to send the packet out. In some cases, the virtual router ID, transaction ID, and client hardware MAC address are not guaranteed to be unique.

When the match-circuit-id command is enabled this part of the key is used to guarantee correctness in our lookup. This is only needed when dealing with an IP aware DSLAM that proxies the client hardware MAC address.

The no form of this command reverts to the default.

option

Syntax 
[no] option
Context 
config>service>vprn>if>dhcp
config>service>vprn>sub-if>dhcp
config>service>vprn>sub-if>grp-if>dhcp
config>service>vpls>sap>dhcp
config>service>ies>if>dhcp
config>service>ies>sub-if>grp-if>dhcp
Description 

This command enables DHCP Option 82 (Relay Agent Information Option) parameters processing and enters the context for configuring Option 82 sub-options.

The no form of this command returns the system to the default.

vendor-specific-option

Syntax 
[no] vendor-specific-option
Context 
config>service>ies>sub-if>dhcp
config>service>vprn>if>dhcp>option
config>service>vprn>sub-if>grp-if>dhcp>option
Description 

This command configures the Nokia vendor specific sub-option of the DHCP relay packet.

The no form of this command reverts to the default.

client-mac-address

Syntax 
[no] client-mac-address
Context 
config>service>ies>sub-if>dhcp>option
config>service>vprn>if>dhcp>option>vendor
config>service>vprn>if>dhcp>option>vendor
config>service>vprn>sub-if>grp-if>dhcp>option>vendor
Description 

This command enables the sending of the MAC address in the Nokia vendor specific sub-option of the DHCP relay packet.

The no form of this command disables the sending of the MAC address in the Nokia vendor specific sub-option of the DHCP relay packet.

The no form of this command reverts to the default.

sap-id

Syntax 
[no] sap-id
Context 
config>service>vprn>if>dhcp>option>vendor
config>service>vprn>sub-if>grp-if>dhcp>option>vendor
Description 

This command enables the sending of the SAP ID in the Nokia vendor specific sub-option of the DHCP relay packet.

The no form of this command disables the sending of the SAP ID in the Nokia vendor specific sub-option of the DHCP relay packet.

service-id

Syntax 
[no] service-id
Context 
config>service>vprn>if>dhcp>option>vendor
config>service>vprn>sub-if>grp-if>dhcp>option>vendor
Description 

This command enables the sending of the service ID in the Nokia vendor specific sub-option of the DHCP relay packet.

The no form of this command disables the sending of the service ID in the Nokia vendor specific sub-option of the DHCP relay packet.

string

Syntax 
[no] string text
Context 
config>service>vprn>if>dhcp>option>vendor
config>service>vprn>sub-if>grp-if>dhcp>option>vendor
Description 

This command specifies the vendor specific sub-option string of the DHCP relay packet.

The no form of this command returns the default value.

Parameters 
text—
Specifies that the string can be any combination of ASCII characters, up to 32 characters. If spaces are used in the string, enclose the entire string in quotation marks (“ ”).

system-id

Syntax 
[no] system-id
Context 
config>service>vprn>if>dhcp>option>vendor
config>service>vprn>sub-if>grp-if>dhcp>option>vendor
Description 

This command specifies whether the system-id is encoded in the Nokia vendor specific sub-option of Option 82.

The no form of this command reverts to the default.

host-connectivity-verify

Syntax 
host-connectivity-verify source-ip ip-address [source-mac ieee-address] [interval interval] [action {remove | alarm}] [timeout retry-timeout] [retry-count count]
Context 
config>service>vpls
config>service>vpls>sap
Description 

This command enables subscriber host connectivity verification on a given VPLS SAP or within a VPLS service.

This tool will periodically scan all known hosts (from dhcp-state) and perform a UC ARP request. The subscriber host connectivity verification will maintain state (connected vs. not-connected) for all hosts.

The no form of this command reverts to the default.

Parameters 
ip-address—
Specifies an unused IP address in the same network for generation of subscriber host connectivity verification packets
ieee-address—
Specifies the source MAC address to be used for generation of subscriber host connectivity verification packets
interval—
The interval, in minutes, which specifies the time interval in which all known sources should be verified. The actual rate is then dependent on number of known hosts and interval.
Values—
1 to 6000 Note that a zero value can be used by the SNMP agent to disable host-connectivity-verify.

 

action {remove | alarm}—
Defines the action taken on a subscriber host connectivity verification failure for a given host. The remove keyword raises an alarm and removes dhcp-state and releases all allocated resources (queues, table entries, and so on). DHCP release will be signaled to corresponding DHCP server. Static host will be never removed. The alarm keyword raises an alarm indicating that the host is disconnected.
retry-timeout—
Specifies the time, in seconds, to wait before a SAP that has been disabled after exceeding the maximum relearn rate is re-enabled
Values—
0 to 120

 

count—
Specifies the number of connectivity check retransmissions
Values—
10 to 60 seconds

 

source-address

Syntax 
source-address ipv6-address
no source-address
Context 
config>service>ies>if>ipv6>dhcp6-relay
config>service>ies>sub-if>ipv6>dhcp6>relay
config>service>ies>sub-if>grp-if>ipv6>dhcp6>relay
config>service>vprn>if>ipv6>dhcp6-relay
config>service>vprn>sub-if>ipv6>dhcp6>relay
config>service>vprn>sub-if>grp-if>ipv6>dhcp6>relay
Description 

This command configures the source IPv6 address of the DHCPv6 relay messages.

The no form of this command reverts to the default.

Parameters 
ipv6-address—
Specifies the source IPv6 address of the DHCPv6 relay messages
Values—

ipv6-address:

x:x:x:x:x:x:x:x (eight 16-bit pieces)

x:x:x:x:x:x:d.d.d.d

x: [0 to FFFF]H

d: [0 to 255]D

 

ipoe-bridged-mode

Syntax 
[no] ipoe-bridged-mode
Context 
config>service>ies>sub-if>ipv6
config>service>ies>sub-if>grp-if>ipv6
config>service>vprn>sub-if>ipv6
config>service>vprn>sub-if>grp-if>ipv6
Description 

This command enables IPv6 IPoE bridged mode.

The no form of this command disables the IPv6 IPoE bridged mode.

user-db

Syntax 
user-db local-user-db-name
no user-db
Context 
config>service>ies>if>ipv6>dhcp6-relay
config>service>vprn>if>ipv6>dhcp6-relay
Description 

This command enables access to the LUDB for DHCPv6 messages under a routed interface. The name of this LUDB must match the name of the LUDB configured by the config>sub-gmt>local-user-db command.

The no form of this command reverts to the default.

Parameters 
local-user-db-name—
Specifies the name of the local user database, up to 32 characters

dhcp6-server

Syntax 
[no] dhcp6-server
Context 
config>service>ies>if>ipv6
config>service>vprn>if>ipv6
Description 

This command enables the context to configure DHCPv6 server parameters for the IES interface.

The no form of this command disables the DHCP6 server.

max-nbr-of-leases

Syntax 
max-nbr-of-leases max-nbr-of-leases
no max-nbr-of-leases
Context 
config>service>ies>if>ipv6>dhcp6-server
Description 

This command configures the maximum number of lease states installed by the DHCP6 server function allowed on this interface.

The no form of this command to the default.

Default 

max-nbr-of-leases 8000

Parameters 
max-nbr-of-leases—
Specifies the maximum number of lease states installed by the DHCP6 server function allowed on this interface
Values—
0 to 8000

 

prefix-delegation

Syntax 
[no] prefix-delegation
Context 
config>service>ies>if>ipv6>dhcp6-server
Description 

This command enables the prefix delegation options for delegating a long-lived prefix from a delegating router to a requesting router, where the delegating router does not require knowledge about the topology of the links in the network to which the prefixes will be assigned.

The no form of this command disables prefix-delegation.

prefix

Syntax 
[no] prefix ipv6-address/prefix-length
Context 
config>service>ies>if>ipv6>dhcp6-server>pfx-delegate
Description 

This command specifies the IPv6 prefix that will be delegated by this system.

The no form of this command reverts to the default.

Parameters 
ipv6-address/prefix-length—
Specifies the IPv6 address on the interface
Values—

ipv6-address/prefix:

ipv6-address

x:x:x:x:x:x:x:x (eight 16-bit pieces)

x:x:x:x:x:x:d.d.d.d

x [0 to FFFF]H

d [0 to 255]D

prefix-length

1 to 128

 

local-dhcp-server

Syntax 
local-dhcp-server server-name
no local-dhcp-server server-name
Context 
config>router>dhcp
config>service>vprn>dhcp
Description 

This command instantiates a local DHCP server. A local DHCP server can serve multiple interfaces but is limited to the routing context it was which it was created.

The no form of this command reverts to the default.

Parameters 
server-name —
Specifies the name of local DHCP server.

local-proxy-arp

Syntax 
[no] local-proxy-arp
Context 
config>service>vprn>if
config>service>vprn>sub-if>grp-if
Description 

This command enables local proxy ARP. When local proxy ARP is enabled on an IP interface, the system responds to all ARP requests for IP addresses belonging to the subnet with its own MAC address, and thus will become the forwarding point for all traffic between hosts in that subnet. When local-proxy-arp is enabled, ICMP redirects on the ports associated with the service are automatically blocked.

The no form of this command reverts to the default.

mac

Syntax 
[no] mac ieee-mac-address
Context 
config>service>vprn>if
config>service>vprn>if>vrrp
config>service>vprn>sub-if>grp-if
Description 

This command assigns a specific MAC address to a VPRN IP interface.

The no form of this command returns the MAC address of the IP interface to the default value.

Default 

The physical MAC address associated with the Ethernet interface on which the SAP is configured.

Parameters 
ieee-mac-address—
Specifies the 48-bit MAC address for the static ARP in the form aa:bb:cc:dd:ee:ff or aa-bb-cc-dd-ee-ff where aa, bb, cc, dd, ee and ff are hexadecimal numbers. Allowed values are any non-broadcast, non-multicast MAC and non-IEEE reserved MAC addresses.

proxy-arp-policy

Syntax 
[no] proxy-arp-policy policy-name [policy-name)
Context 
config>service>vprn>if
config>service>vprn>sub-if>grp-if
Description 

This command enables a proxy ARP policy for the interface.

The no form of this command disables the proxy ARP capability.

Parameters 
policy-name—
Specifies up to five export route policy names. Allowed values are any string up to 32 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

The specified name(s) must already be defined.

redundant-interface

Syntax 
redundant-interface red-ip-int-name
no redundant-interface
Context 
config>service>vprn
config>service>vprn>sub-if>grp-if
Description 

This command configures a redundant interface used for dual homing.

The no form of this command reverts to the default.

Parameters 
red-ip-int-name—
Specifies the redundant IP interface name

remote-proxy-arp

Syntax 
[no] remote-proxy-arp
Context 
config>service>vprn>if
config>service>vprn>sub-if>grp-if
Description 

This command enables remote proxy ARP on the interface.

Remote proxy ARP is like proxy ARP. It allows the router to answer an ARP request on an interface for a subnet that is not provisioned on that interface. This allows the router to forward to the other subnet on behalf of the requester. To distinguish remote proxy ARP from local proxy ARP, local proxy ARP performs a similar function but only when the requested IP is on the receiving interface.

The no form of this command reverts to the default.

3.6.2.1.8. System DHCP Commands

dhcp6

Syntax 
dhcp6
Context 
config>system
Description 

This command enables the context to configure system DHCP6 parameters.

adv-noaddrs-global

Syntax 
adv-noaddrs-global [esm-proxy] [esm-relay] [relay] [server]
no adv-noaddrs-global
Context 
config>system>dhcp6
Description 

This command configures the different DHCPv6 applications to send the NoAddrsAvail Status-Code in DHCPv6 Advertise messages at the global DHCP message level.

By default, all applications send the NoAddrsAvail Status-Code in DHCPv6 Advertise messages at the IA_NA Option level.

Different applications for which NoAddrsAvail Status-Code in DHCPv6 Advertise messages can be configured at the global DHCP message level.

The only valid combination in current SR OS is adv-noaddrs-global esm-relay server.

The no form of this command reverts to the default.

Default 

no adv-noaddrs-global. All applications send the NoAddrsAvail Status-Code in DHCPv6 Advertise messages at the IA_NA Option level.

Parameters 
esm-proxy—
Specifies the DHCPv6 proxy server on subscriber group-interfaces. Not supported in current SR OS.
esm-relay —
Specifies the DHCPv6 relay on subscriber group-interfaces. Must be enabled together with the DHCPv6 server (server) application.
relay —
Specifies the DHCPv6 relay on regular IES or VPRN interfaces. Not supported in current SR OS.
server—
Specifies the DHCPv6 server. Must be enabled together with the DHCPv6 relay on subscriber interfaces (esm-relay) application.

3.6.2.1.9. Show Commands

Note:

The command output in the following section are examples only; actual displays may differ depending on supported functionality and user configuration.

dhcp

Syntax 
dhcp
Context 
show>router
show>service>id
Description 

This command enables the context to display DHCP related information.

dhcp6

Syntax 
dhcp6
Context 
show>router
show>service>id
show>system
Description 

This command enables the context to display DHCP6 related information.

local-dhcp-server

Syntax 
local-dhcp-server server-name
Context 
show>router>dhcp
show>router>dhcp6
Description 

This command displays local DHCP or DHCP6 server information.

Parameters 
server-name—
Specifies information about the local DHCP server

associations

Syntax 
associations
Context 
show>router>dhcp
show>router>dhcp6
show>router>dhcp>server
Description 

This command displays the interfaces associated with this DHCP or DHCP6 server.

Output 

The following output is an example of information associated with this DHCP or DHCP6 server.

Sample Output
*A:SUB-Dut-A# show router dhcp local-dhcp-server dhcpS1 associations 
===============================================================================
DHCP server s1  router 3
===============================================================================
Associations                     Admin                           
-------------------------------------------------------------------------------
tosim5                           Up                              
===============================================================================
*A:SUB-Dut-A# 
*A:SUB-Dut-A# show router dhcp6 local-dhcp-server abc associations 
===============================================================================
DHCP server abc  router 3
===============================================================================
Associations                     Admin                           
-------------------------------------------------------------------------------
tosimxyz                           Up                              
===============================================================================
*A:SUB-Dut-A# 

Table 40 describes DHCP associations fields.

Table 40:  DHCP6 Summary Field Descriptions 

Label

Description  

Associations

The entity associated with the local DHCP server

Admin

The administrative state

declined-addresses

Syntax 
declined-addresses ip-address[/mask] [detail]
declined-addresses pool pool-name
Context 
show>router>dhcp>server
Description 

This command display information about declined addresses.

Parameters 
pool-name—
Specifies a DHCP pool name on the router.
ip-address—
Specifies the IP address of the DNS server. This address must be unique within the subnet and specified in dotted decimal notation. Allowed values are IP addresses in the range 1.0.0.0 – 223.255.255.255 (with support of /31 subnets).
detail—
Displays detailed information
Output 

The following output is an example of declined address information

Sample Output
*A:ALA-48>show>router>dhcp>server# declined-addresses pool test
===============================================================================
Declined addresses for server test Base
===============================================================================
 Pool                              Subnet              IP Address
PPPoe User Name                  Time                MAC Address       Type
Option 82 Circuit ID
-------------------------------------------------------------------------------
No Matching Entries
===============================================================================
*A:ALA-48>show>router>dhcp>server#

Table 41 describes declined address pool output fields.

Table 41:  Declined Address Pool Field Descriptions  

Field

Description

Pool

The name of the IP address pool

Subnet

The subnet address

IP Address

The declined IP address

Time

The creation time of this entry

MAC Address

The declined MAC address

Type

The type of declined address

PPPoE User Name

The name of the PPPoE user name

Option 82 Circuit ID

The declined circuit ID from the Option 82

failover-pool-stats

Syntax 
failover-pool-stats [pool-name]
Context 
show>router>dhcp>local-dhcp-server
show>router>dhcp6>local-dhcp-server
Description 

This command displays failover pool statistics.

Parameters 
pool-name—
Specifies the pool name which is defined in the system
Output 

The following output is an example of failover pool stats information

Sample Output
*A:cses-V22>show>router>dhcp>server# failover-pool-stats
==================================================================
Failover config for pool         test
==================================================================
Failover Admin State             outOfService
Failover Oper State              shutdown
Failover Persist Key             0xFFFFFFFF
Administrative MCLT              0h10m0s
Operational MCLT                 0h10m0s
Startup Wait Time                0h2m0s
Partner Down Delay               23h59m59s
  Ignore MCLT                    disabled
Failover statistics for pool     test
------------------------------------------------------------------
Dropped Invalid Packets          0
Failover Shutdown                0
Lease Already Expired            0
Maximum Lease Count Reached      0
Subnet Not Found                 0
Range Not Found                  0
Host Conflict                    0
Address Conflict                 0
Peer Conflict                    0
Persistence Congestion           0
No Lease Hold Time Configured    0
Invalid Prefix Length            0
Lease Not Found                  0
------------------------------------------------------------------
Number of pools found            1
==================================================================
*A:cses-V22>show>router>dhcp>server#
*A:vsim-2# show router 500 dhcp6 local-dhcp-server "d6" failover-pool-stats 
==================================================================
Failover config for pool         v6-1
==================================================================
Failover Admin State             inService
Failover Oper State              preNormal
Failover Persist Key             0xFFFFFFFF
Administrative MCLT              0h10m0s
Operational MCLT                 0h10m0s
Startup Wait Time                0h2m0s
Partner Down Delay               23h59m59s
  Ignore MCLT                    disabled
Failover statistics for pool     v6-1
------------------------------------------------------------------
Dropped Invalid Packets          0
Failover Shutdown                0
Lease Already Expired            0
Maximum Lease Count Reached      0
Subnet Not Found                 0
Range Not Found                  0
Host Conflict                    0
Address Conflict                 0
Peer Conflict                    0
Persistence Congestion           0    
No Lease Hold Time Configured    0
Lease Not Found                  0
------------------------------------------------------------------
Number of pools found            1
==================================================================

Table 42 describes failover pool statistics output fields.

Table 42:  Failover Pool Statistics Field Descriptions 

Field

Description

Failover Admin State

Identifiers the failover state of the DHCP server instance

inService — The failover admin state is in service

outOfService — The failover admin state is out of service

Failover Oper State

The operational state of a DHCP server instance

Failover Persist Key

The maximum amount of time that one server can extend a lease for a client's binding beyond the time known by the partner server

Administrative MCLT

The administrative Maximum Client Lead Time (MCLT)

Operational MCLT

Indicates the operational MCLT

Startup Wait Time

The startup wait time. The startup wait time is the time that one IP address pool attempts to contact the partner IP address pool. During this time, the IP address pool is unresponsive to DHCP client requests.

Partner Down Delay

The minimum safe-time after the beginning of COMMUNICATIONS-INTERRUPTED state.

After the expiry of this time, the server enters the PARTNER-DOWN state.

Ignore McLT

The ignore McLT status. If, after the transition COMMUNICATIONS-INTERRUPTED-to-PARTNER-DOWN state, the DHCP server instance ignores the safety period with a duration of Maximum Client Lead Time; a ‘true’ value has the effect that the DHCP server starts offering IP addresses from the partner's scope immediately after this transition, without waiting for existing leases allocated by the partner and not known by this system to time out.

A ‘true’ value increases the risk that duplicate addresses are offered; if the transition to PARTNER-DOWN state is likely to be caused by a failure of the partner system rather than a communications problem, this risk is reduced.

Failover statistics for pool

The failover statistics for each pool

Dropped Invalid Packets

The number of BNDUPD packets that were dropped because the packet was malformed

Failover Shutdown

The number of BNDUPD packets that were dropped because the failover state if the DHCP server instance is shut down

Lease Already Expired

The number of BNDUPD packets that were dropped because the corresponding lease has expired

Maximum Lease Count Reached

The number of BNDUPD packets that were dropped because the maximum number of leases were reached

Subnet Not Found

The number of BNDUPD packets that were dropped because a valid subnet could not be found for the lease

Range Not Found

The number of BNDUPD packets that were dropped because a valid include range could not be found for the lease

Host Conflict

The number of BNDUPD packets that were dropped because this DHCP server instance has already leased this address to another host

Address Conflict

The number of BNDUPD packets that were dropped because this DHCP server instance has already leased another address to this host

Peer Conflict

The number of BNDUPD packets that were dropped because the failover peer has leased an address within a subnet range of which the failover control is set to local on this local DHCP server instance

Persist Congestion

The number of BNDUPD packets that were dropped because of persistence congestion on this DHCP server instance

No Lease Hold Time Configured

The number of BNDUPD packets that were dropped because the lease hold time is zero on this DHCP server instance

Lease Not Found

The number of Binding Database Update (BNDUPD) remove packets were dropped because the corresponding lease could not be found.

Number of pools found

The total number of pools found

failover-server-stats

Syntax 
failover-server-stats
Context 
show>router>dhcp>local-dhcp-server
show>router>dhcp6>local-dhcp-server
Description 

This command displays failover server statistics.

Output 

The following output is an example of failover server stats information.

Sample Output
show>router>dhcp# local-dhcp-server "y" failover-server-stats  
==================================================================
Failover config for server       y
==================================================================
Failover Admin State             outOfService
Failover Oper State              shutdown
Failover Persist Key             0xFFFFFFFF
Administrative MCLT              0h10m0s
Operational MCLT                 0h10m0s
Startup Wait Time                0h2m0s
Partner Down Delay               23h59m59s
  Ignore MCLT                    disabled
 
Failover statistics for server   y
------------------------------------------------------------------
Dropped Invalid Packets          0
Failover Shutdown                0
Lease Already Expired            0
Maximum Lease Count Reached      0
Subnet Not Found                 0
Range Not Found                  0
Host Conflict                    0
Address Conflict                 0
Peer Conflict                    0
Persistence Congestion           0
No Lease Hold Time Configured    0
Invalid Prefix Length            0
Lease Not Found                  0
==================================================================

*A:cses-V26>show>router>dhcp6>server# failover-server-stats
==================================================================
Failover config for server       test1
==================================================================
Failover Admin State             outOfService
Failover Oper State              shutdown
Failover Persist Key             0xFFFFFFFF
Administrative MCLT              0h10m0s
Operational MCLT                 0h10m0s
Startup Wait Time                0h2m0s
Partner Down Delay               23h59m59s
  Ignore MCLT                    disabled
Failover statistics for server   test1
------------------------------------------------------------------
Dropped Invalid Packets          0
Failover Shutdown                0
Lease Already Expired            0
Maximum Lease Count Reached      0
Subnet Not Found                 0
Range Not Found                  0
Host Conflict                    0
Address Conflict                 0
Peer Conflict                    0
Persistence Congestion           0
No Lease Hold Time Configured    0
Invalid Prefix Length            0
Lease Not Found                  0
==================================================================
*A:cses-V26>show>router>dhcp6>server#

Table 43 describes failover server stats fields.

Table 43:  Failover Server Statistics Field Descriptions 

Field

Description

Failover Admin State

Identifiers the failover state of the DHCP server instance

inService — The failover admin state is in service

outOfService — The failover admin state is out of service

Failover Oper State

The operational state of a DHCP server instance

Failover Persist Key

The maximum amount of time that one server can extend a lease for a client's binding beyond the time known by the partner server

Administrative MCLT

The administrative Maximum Client Lead Time (MCLT)

Operational MCLT

Indicates the operational MCLT

Startup Wait Time

The startup wait time. The startup wait time is the time that one IP address pool attempts to contact the partner IP address pool. During this time, the IP address pool is unresponsive to DHCP client requests.

Partner Down Delay

The minimum safe-time after the beginning of COMMUNICATIONS-INTERRUPTED state.

After the expiry of this time, the server enters the PARTNER-DOWN state.

Ignore McLT

The ignore McLT status. If, after the transition COMMUNICATIONS-INTERRUPTED-to-PARTNER-DOWN state, the DHCP server instance ignores the safety period with a duration of Maximum Client Lead Time; a ‘true’ value has the effect that the DHCP server starts offering IP addresses from the partner's scope immediately after this transition, without waiting for existing leases allocated by the partner and not known by this system to time out.

A ‘true’ value increases the risk that duplicate addresses are offered; if the transition to PARTNER-DOWN state is likely to be caused by a failure of the partner system rather than a communications problem, this risk is reduced.

Failover statistics for server

The failover statistics for each pool

Dropped Invalid Packets

The number of BNDUPD packets that were dropped because the packet was malformed

Failover Shutdown

The number of BNDUPD packets that were dropped because the failover state if the DHCP server instance is shut down

Lease Already Expired

The number of BNDUPD packets that were dropped because the corresponding lease has expired

Maximum Lease Count Reached

The number of BNDUPD packets that were dropped because the maximum number of leases were reached

Subnet Not Found

The number of BNDUPD packets that were dropped because a valid subnet could not be found for the lease

Range Not Found

The number of BNDUPD packets that were dropped because a valid include range could not be found for the lease.

Host Conflict

The number of BNDUPD packets that were dropped because this DHCP server instance has already leased this address to another host

Address Conflict

The number of BNDUPD packets that were dropped because this DHCP server instance has already leased another address to this host

Peer Conflict

The number of BNDUPD packets that were dropped because the failover peer has leased an address within a subnet range of which the failover control is set to local on this local DHCP server instance

Persist Congestion

The number of BNDUPD packets that were dropped because of persistence congestion on this DHCP server instance

No Lease Hold Time Configured

The number of BNDUPD packets that were dropped because the lease hold time is zero on this DHCP server instance

Lease Not Found

The number of Binding Database Update (BNDUPD) remove packets were dropped because the corresponding lease could not be found.

free-addresses

Syntax 
free-addresses ip-address[/mask]
free-addresses summary [subnet ip-address[/mask]
free-addresses pool pool-name
Context 
show>router>dhcp>local-dhcp-server
Description 

This command displays the free addresses in a subnet.

Parameters 
pool-name—
Specifies a DHCP pool name on the router
subnet—
Specifies a subnet of IP addresses that are served from the pool.
summary—
Displays summary output of the free addresses
Output 

The following output is an example of free address information

Sample Output
*A:ALA-48>show>router>dhcp>local-dhcp-server# free addresses pool test subnet 10.0.0.0/24
===============================================================================
Free addresses in subnet 10.0.0.0/24
===============================================================================
IP Address 
-------------------------------------------------------------------------------
No. of free addresses: 0
===============================================================================
*A:ALA-48>show>router>dhcp>local-dhcp-server#
 

Table 44 describes free addresses pool command output fields.

Table 44:  Free Addresses Field Descriptions  

Field

Description

IP Address

The free IP addresses in the subnet

No of free addresses

The total number of free addresses in the subnet

leases

Syntax 
leases [detail]
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]
Context 
show>router>dhcp>local-dhcp-server
Description 

This command displays the DHCP leases.

Parameters 
ip-address—
Specifies the base IP address of the subnet. This address must be unique within the subnet and specified in dotted decimal notation. Allowed values are IP addresses in the range 1.0.0.0 – 223.255.255.255 (with support of /31 subnets).
mask—
The subnet mask in dotted decimal notation
Values—
0 to 32

 

address-from-user-db—
Displays only leases that have IP addresses from the local-user-db
dhcp-host-name—
Shows the leases that match a certain DHCP host from the local-user-db
ppp-host-name —
Displays the leases that match a certain PPPoE host from the local-user-db
detail—
Displays detailed information of all leases that fall into the indicated subnet.

The command with no parameters shows all leases from the local-user-db.

Output 

The following output is an example of lease information

Sample Output
*A:ALA-48>show>router>dhcp>local-dhcp-server# leases ip-address 10.0.0.4
===============================================================================
Leases for DHCP server test router Base
===============================================================================
IP Address      Lease State       Mac Address       Remaining Clnt  
  PPPoE user name/Opt82 Circuit Id                  LifeTime  Type  
-------------------------------------------------------------------------------
No leases found
*A:ALA-48>show>router>dhcp>local-dhcp-server#
 

Table 45 describes leases output fields.

Table 45:  Leases Field Descriptions  

Field

Description

IP Address

The IP address for the specified lease

Lease State

The lease state of the IP address

Mac Address

The MAC address of the lease

Remaining Lifetime

The remaining lifetime of the lease

Clnt Type

The address type

PPPoE user name

The PPPoE user name

Opt82

The option number that the DHCP server uses to send the identification strings to the PPPoE client

Circuit ID

The circuit ID from Option 82

pool-ext-stats

Syntax 
pool-ext-stats [pool-name]
Context 
show>router>dhcp>server
Description 

This command displays extended statistics per DHCPv4 pool in local DHCPv4 server.

The following statistics are included in output:

  1. The number of stable leases in the pool
  2. The number of provisioned address in the pool
  3. The number of used address in the pool
  4. The number of free address in the pool
  5. The percentage of used address
  6. The percentage of free address

For each statistic (except for provisioned addresses), there is current value and peak value, peak value is the highest value since pool creation or last reset via the clear router rt-id dhcp local-dhcp-server svr-name pool-ext-stats command.

Parameters 
pool-name—
Specifies the name of DHCPv4 local server pool
Output 

The following output is an example of pool extended statistics information.

Sample Output
show router 500 dhcp local-dhcp-server "d4" pool-ext-stats "pool-1" 
===============================================================================
Extended pool statistics for server "d4"
===============================================================================
                           Current         Peak            TimeStamp
-------------------------------------------------------------------------------
Pool                       pool-1
Local:
  Stable Leases            0               0               01/07/2013 19:07:11
  Provisioned Addresses    101                             
  Used Addresses           0               0               01/07/2013 19:07:11
  Free Addresses           101             101             01/07/2013 19:07:11
  Used Pct                 0               0               01/07/2013 19:07:11
  Free Pct                 100             100             01/07/2013 19:07:11
Last Reset Time                                            01/07/2013 19:07:11
-------------------------------------------------------------------------------
Number of entries          1
===============================================================================
 

Table 46 describes extended pool statistics output fields.

Table 46:  Extended Pool Statistics Field Descriptions  

Field

Description

Current

The current pool statistics

Peak

The peak value since the last reset

Timestamp

The date and time of the last reset

Pool

The pool name

Stable Leases

The number of stable leases in the pool

Provisioned Addresses

The number of provisioned addresses in the pool

Used Addressed

The number of used addresses in the pool

Free Addresses

The number of free addresses in the pool

Used Pct

The percentage of subnets in use in the pool

Free Pct

The percentage of unused subnets in the pool

Last Reset Time

The date and time of the last reset in the pool

Number of entries

The total number of entries

server-stats

Syntax 
server-stats
Context 
show>router>dhcp>server
show>router>dhcp6>server
Description 

This command displays DHCP or DHCP6 server statistics.

Output 

The following output is an example of server statics information

Sample Output
*A:SUB-Dut-A# show router dhcp local-dhcp-server dhcpS1 server-stats 
==============================================================================
Statistics for DHCP Server dhcpS1 router Base
==============================================================================
Rx Discover Packets           : 0                                             
Rx Request Packets            : 0                                             
Rx Release Packets            : 0                                             
Rx Decline Packets            : 0                                             
Rx Inform Packets             : 0                                             
 
Tx Offer Packets              : 0                                             
Tx Ack Packets                : 0                                             
Tx Nak Packets                : 0                                             
Tx Forcerenew Packets         : 0                                             
 
Client Ignored Offers         : 0                                             
Leases Timed Out              : 0                                             
 
Dropped Bad Packet            : 0                                             
Dropped Invalid Type          : 0                                             
Dropped No User Database      : 0                                             
Dropped Unknown Host          : 0                                             
Dropped User Not Allowed      : 0                                             
Dropped Lease Not Ready       : 0                                             
Dropped Lease Not Found       : 0                                             
Dropped Not Serving Pool      : 0                                             
Dropped Invalid User          : 0                                             
Dropped Overload              : 0                                             
Dropped Persistence Overload  : 0                                             
Dropped Generic Error         : 0                                             
Dropped Destined To Other     : 0                                             
Dropped Address Unavailable   : 0                                             
Dropped Max Leases Reached    : 0                                             
Dropped Server Shutdown       : 0                                             
Dropped No Subnet For Fixed IP: 0                                             
 
==============================================================================
*A:SUB-Dut-A#

*A:cses-V26>show>router>dhcp6>server# server-stats
===============================================================================
Statistics for DHCPv6 Server test1 router Base
===============================================================================
Rx Solicit Packets            : 0
Rx Request Packets            : 0
Rx Confirm Packets            : 0
Rx Renew Packets              : 0
Rx Rebind Packets             : 0
Rx Decline Packets            : 0
Rx Release Packets            : 0
Rx Information Request Packets: 0
Rx Leasequery Packets         : 0
Tx Advertise Packets          : 0
Tx Reply Packets              : 0
Tx Reconfigure Packets        : 0
Tx Leasequery Reply Packets   : 0
Client Ignored Offers         : 0
Leases Timed Out              : 0
Dropped Bad Packet            : 0
Dropped Invalid Type          : 0
Dropped Lease Not Ready       : 0
Dropped Not Serving Pool      : 0
Dropped Overload              : 0
Dropped Persistence Overload  : 0
Dropped Generic Error         : 0
Dropped Destined To Other     : 0
Dropped Max Leases Reached    : 0
Dropped Server Shutdown       : 0
Dropped Leasequery Not Allowed: 0
Dropped Duplicate             : 0
Dropped busy primary audit    : 0
Rx Int. PPP SLAAC Requests    : 0
Rx Int. IPoE SLAAC Requests   : 0
Rx Int. IPoE WAN Requests     : 0
Rx Int. IPsec                 : 0
Rx Internal Releases          : 0
Dropped Internal w/Failover   : 0
Dropped Internal w/Int-id-map : 0
Dropped Internal w/User-ident : 0
Dropped Internal w/Conflicts  : 0
Failover statistics
-------------------------------------------------------------------------------
Dropped Invalid Packets       : 0
Failover Shutdown             : 0
Lease Already Expired         : 0
Maximum Lease Count Reached   : 0
Prefix Not Found              : 0
Host Conflict                 : 0
Address Conflict              : 0
Peer conflict                 : 0
Persistence congestion        : 0
No Lease Hold Time Configured : 0
Invalid Prefix Length         : 0
Lease Not Found               : 0
===============================================================================
*A:cses-V26>show>router>dhcp6>server#

Table 47 describes server stats show command output fields.

Table 47:  Server Stats Field Descriptions  

Field

Description

RX Discover Packets

The number of discover packets received by the DHCP server instance

Rx Request Packets

The number of request packets received by the DHCP server instance.

Rx Release Packets

The number of released packets received by the DHCP server instance

Rx Decline Packets

The number of declined packets received by the DHCP server instance

Rx Inform Packets

The number of inform packets received by the DHCP server instance

Tx Offer Packets

The number of offer packets sent by the DHCP server instance

Tx Ack Packets

The number of DHCP ACK packets sent by the DHCP server instance

Tx Nak Packets

The number of DHCP NAK packets sent by the DHCP server instance

Tx Forcerenew Packets

The number of DHCP force renew packets sent by the server instance

Client Ignored Offers

The number of DHCP offer packets sent by the DHCP server instance that were ignored by clients

Leases Timed Out

The number of leases timed out

Dropped Bad Packet

The number of dropped of DHCP packets received that were corrupt

Dropped Invalid Type

The number of DHCP packets received that had an invalid message type

Dropped No User Database

The number of DHCP packets dropped because the value of this server instance is not equal to the default value and a local user database with that name could not be found

Dropped Unknown Host

The number of DHCP packets dropped from hosts which were not found in the user database

Dropped User Not Allowed

The number of DHCP packets dropped from hosts which are found in the user database, but which have no address or pool specified

Dropped Lease Not Ready

The number of DHCP packets dropped by the server instance before the lease database was ready

Dropped Lease Not Found

The number of DHCP packets dropped by the server instance because no (valid) lease was found

Dropped Not Serving Pool

The number of DHCP packets dropped by the server instance because there were no more free addresses in the pool

Dropped Invalid User

The number of DHCP packets dropped by the server instance because the MAC address of the sender or the option 82 didn't match the host lease state

Dropped Overload

The number of DHCP packets dropped by the server instance because they were received more than the server instance can handle

Dropped Persistence Overload

The number of DHCP packets dropped by the server instance because they were received in more than the DHCP persistence system can handle. If this occurs, only releases and declines are still processed.

Dropped Generic Error

The number of DHCP packets dropped by the server instance because of a generic error

Dropped Destined To Other

The number of DHCP requests dropped by the server instance because the (broadcast) request was not destined to this server

Dropped Address Unavailable

The number of DHCP requests dropped by the server instance because the requested address is not available

Dropped Max Leases Reached

The number of DHCP packets dropped by the server instance because the maximum number of leases was reached

Dropped Server Shutdown

The number of DHCP packets dropped by the server instance during server instance shutdown

Dropped No Subnet for Fixed IP

The number of DHCP packets dropped by the server instance for user-db hosts with a fixed address because the subnet to which the address belongs is not configured

sticky-leases

Syntax 
sticky-leases [hostname]
Context 
show>router>dhcp>server
Description 

This command shows either all sticky leases or a single specific sticky lease created under the specified DHCP server.

Parameters 
hostname—
Specifies the name of the host for which an entry is created
Output 

The following output is an example of sticky lease information

Sample Output
Node# show router dhcp local-dhcp-server "dhcp_server" sticky-leases
===============================================================================
DHCP Server Sticky Leases
===============================================================================
Hostname                           IP address
-------------------------------------------------------------------------------
test_lease                         10.0.0.1
-------------------------------------------------------------------------------
No. of Matching Entries: 1
===============================================================================

Table 48 describes the sticky leases field descriptions.

Table 48:  Sticky Leases Field Descriptions  

Field

Description

Hostname

The name of the sticky host

IP address

The IP address of the sticky host

No. of Matching Entries

The total numbers of entries matching the command criteria

subnet-ext-stats

Syntax 
subnet-ext-stats ip-address[/mask]
subnet-ext-stats pool pool-name
Context 
show>router>dhcp>servers
Description 

This command displays extended statistics per DHCPv4 subnet in local DHCPv4 server.

The following statistics are included in output:

  1. The number of stable leases in the subnet
  2. The number of provisioned address in the subnet
  3. The number of used address in the subnet
  4. The number of free address in the subnet
  5. The percentage of used address
  6. The percentage of free address

For each statistic (except for Provisioned Addresses), there is current value and peak value, peak value is the highest value since subnet creation or last reset via the clear router rt-id dhcp local-dhcp-server svr-name subnet-ext-stats command.

When parameter pool is used, the statistics of each subnet in the pool will be displayed.

Parameters 
ip-address[/mask]—
Specifies the subnet and mask
pool-name—
Specifies the name of local DHCPv4 server pool
Output 

The following output is an example of subnet extended statistics information.

Sample Output
show router 500 dhcp local-dhcp-server "d4" subnet-ext-stats 239.10.10.0/24 
===============================================================================
Extended statistics for subnet 239.10.10.0/24
===============================================================================
                           Current         Peak            TimeStamp
-------------------------------------------------------------------------------
Local:
  Stable Leases            1               1               01/07/2013 19:38:36
  Provisioned Addresses    101                             
  Used Addresses           1               1               01/07/2013 19:38:36
  Free Addresses           100             100             01/07/2013 19:38:36
  Used Pct                 1               1               01/07/2013 19:38:36
  Free Pct                 99              99              01/07/2013 19:38:36
Last Reset Time                                            01/07/2013 19:07:11
-------------------------------------------------------------------------------
Number of entries          1
===============================================================================

Table 49 describes extended subnet statistics output field descriptions.

Table 49:  Extended Subnet Statistics Field Descriptions  

Field

Descriptions

Current

The current statistics for the subnet

Peak

The peak statistics for the subnet

TimeStamp

The timestamp for the last reset

Stable Leases

The number of stable leases

Provision Addresses

The number of provisioned addresses in this subnet

Used Addresses

The number of used addresses in this subnet

Free Address

The number of free addresses in this subnet

Used Pct

The percentage of addresses in this subnet in use

Free Pct

The percentage of addresses in this subnet currently unused

Last Reset Time

The time of the last reset

Number of entries

The total number of entries

subnet-stats

Syntax 
subnet-stats ip-address[/mask]
subnet-stats pool pool-name
Context 
show>router>dhcp>server
Description 

This command displays subnet statistics.

Parameters 
ip-address[/mask]—
Specifies the subnet and mask.
pool-name—
Specifies the name of local DHCPv4 server pool.
Output 

The following output is an example of subnet statistics information.

Sample Output
*A:SUB-Dut-A# show router dhcp local-dhcp-server dhcpS2 subnet-stats pool POOL2 
===============================================================================
Statistics for pool POOL2
===============================================================================
Subnet             Free         Offered      Stable                            
                     FRPending    RemPending   Declined                        
-------------------------------------------------------------------------------
10.0.0.0/8          16384        0            0                                 
                     0            0            0                               
-------------------------------------------------------------------------------
No. of entries: 1
===============================================================================
*A:SUB-Dut-A#

Table 50 describe the fields for subnet stats pool output.

Table 50:  Subnet Stats Pool Field Descriptions  

Field

Description

Subnet

The subnet address

Free

The number of addresses in this subnet that are free

Offered

The number of leases in this subnet that are in state offered

Stable

The number of leases in this subnet that are in state stable

FRPending

The number of leases in this subnet that are in state forceRenewPending

RemPending

The number of leases in this subnet that are in state removePending

Declined

The number of addresses in this subnet that are declined

No. of entries

The total number of entries

summary

Syntax 
summary
Context 
show>router>dhcp>server
Description 

This command displays DHCP server summary information.

Output 

The following output is an example of DHCP summary information.

Sample Output
*A:SUB-Dut-A# show router dhcp local-dhcp-server dhcpS2 summary 
===============================================================================
DHCP server dhcpS2  router Base
===============================================================================
dhcpS2-POOL2
Admin State            : inService
Persistency State      : ok
User Data Base         : N/A
Use gateway IP address : disabled
Send force-renewals    : disabled
-------------------------------------------------------------------------------
Pool name : POOL2
-------------------------------------------------------------------------------
Subnet             Free       Stable     Declined   Offered    Remove-pending
-------------------------------------------------------------------------------
10.0.0.0/8         16384      0          0          0          0             
 
Totals for pool    16384      0          0          0          0             
-------------------------------------------------------------------------------
Totals for server  16384      0          0          0          0             
-------------------------------------------------------------------------------
Associations                     Admin                           
-------------------------------------------------------------------------------
No associations found
===============================================================================
*A:SUB-Dut-A# 
 
 
*A:vsim-2# show router 500 dhcp local-dhcp-server "d4" summary 
===============================================================================
DHCP server d4  router 500
===============================================================================
Admin State            : inService
Operational State      : inService
Persistency State      : shutdown
User Data Base         : N/A
Use gateway IP address : enabled (scope subnet)
Use pool from client   : disabled
Send force-renewals    : disabled
Creation Origin        : manual
Lease Hold Time        : 0h0m0s
Lease Hold Time For    : N/A
User-ident             : mac-circuit-id
Failover Admin State   : outOfService
Failover Oper State    : shutdown
Failover Persist Key   : N/A
Administrative MCLT    : 0h10m0s
Operational MCLT       : 0h10m0s
Startup wait time      : 0h2m0s
Partner down delay     : 23h59m59s
  Ignore MCLT          : disabled
-------------------------------------------------------------------------------
Pool name : v4-1
-------------------------------------------------------------------------------
Failover Admin State   : inService
Failover Oper State    : normal
Failover Persist Key   : N/A
Administrative MCLT    : 0h10m0s
Operational MCLT       : 0h10m0s
Startup wait time      : 0h2m0s
Partner down delay     : 23h59m59s
  Ignore MCLT          : disabled
-------------------------------------------------------------------------------
Subnet                 Free     %    Stable   Declined Offered  Rem-pend Drain
-------------------------------------------------------------------------------
10.20.20.0/24      (L) 10       90%  1        0        0        0        N
                   (R) N/A           0        N/A      N/A      N/A      N
Totals for pool        10       90%  1        0        0        0        
-------------------------------------------------------------------------------
Totals for server      10       90%  1        0        0        0        
-------------------------------------------------------------------------------
Interface associations
Interface                        Admin
-------------------------------------------------------------------------------
l1                               Up
-------------------------------------------------------------------------------
Local Address Assignment associations
Group interface                  Admin
-------------------------------------------------------------------------------
===============================================================================
*A:vsim-2# 

servers

Syntax 
servers
servers all
Context 
show>router>dhcp
show>router>dhcp6
Description 

This command lists the local DHCP or DHCP6 servers.

Parameters 
all—
Displays a complete list of local DHCP or DHCP6 servers
Output 

The following output is an example of local DHCP or DHCP6 server information.

Sample Output
*A:ALA-49>show>router>dhcp# servers
=================================================================
Overview of DHCP Servers
=================================================================
Active Leases:      0                                            
Maximum Leases:     159744                                       
 
Router              Server                           Admin State 
-----------------------------------------------------------------
Router: Base        base_router_dhcp_server          outOfService
Service: 3          s1                               inService   
=================================================================
*A:ALA-49>show>router>dhcp#
*A:cses-V26>show>router>dhcp6# servers
==================================================================
Overview of DHCP Servers
==================================================================
Active Leases:      0
Maximum Leases:     159744
Router              Server                           Admin State
------------------------------------------------------------------
Router: Base        dhcp6                            inService
Router: Base        test1                            inService
Router: Base        testtest                         outOfService
==================================================================
*A:cses-V26>show>router>dhcp6#

statistics

Syntax 
statistics [interface ip-int-name]]
Context 
show>router>dhcp
Description 

This command displays statistics for DHCP relay and DHCP snooping.

If no IP address or interface name is specified, then all configured interfaces are displayed.

If an IP address or interface name is specified, then only data regarding the specified interface is displayed.

Parameters 
ip-int-name | ip-address—
Displays statistics for the specified IP interface.
Output 

The following is an example of DHCP statistics information.

Sample Output
*A:PE-5# show router dhcp statistics
====================================================================
DHCP Global Statistics (Router: Base)
====================================================================
Rx Packets                           : 0
Tx Packets                           : 0
Rx Malformed Packets                 : 0
Rx Untrusted Packets                 : 0
Client Packets Discarded             : 0
Client Packets Relayed               : 0
Client Packets Snooped               : 0
Client Packets Proxied (RADIUS)      : 0
Client Packets Proxied (Diameter)    : 0
Client Packets Proxied (User-Db)     : 0
Client Packets Proxied (Lease-Split) : 0
Server Packets Discarded             : 0
Server Packets Relayed               : 0
Server Packets Snooped               : 0
DHCP RELEASEs Spoofed                : 0
DHCP FORCERENEWs Spoofed             : 0
Client packets streamed              : 0
====================================================================

Table 51 describes the output fields for DHCP statistics.

Table 51:  DHCP Statistics Fields 

Label

Description  

Rx Packets

The number of packets received from the DHCP clients

Tx Packets

The number of packets transmitted to the DHCP clients

Rx Malformed Packets

The number of malformed packets received from the DHCP clients

Rx Untrusted Packets

The number of untrusted packets received from the DHCP clients

Client Packets Discarded

The number of packets received from the DHCP clients that were discarded

Client Packets Relayed

The number of packets received from the DHCP clients that were forwarded

Client Packets Snooped

The number of packets received from the DHCP clients that were snooped

Server Packets Discarded

The number of packets received from the DHCP server that were discarded

Server Packets Relayed

The number of packets received from the DHCP server that were forwarded

Server Packets Snooped

The number of packets received from the DHCP server that were snooped

summary

Syntax 
summary
Context 
show>router>dhcp
show>router>dhcp6
Description 

This command displays the status of the DHCP6 relay and DHCP snooping functions on each interface.

Output 

The following outputs display DHCP and DHCP6 summary information.

Sample Output
A:ALA-48>show>router>dhcp# summary
===================================================================
Interface Name                   Arp      Used/     Info    Admin
                                 Populate Provided  Option  State
-------------------------------------------------------------------
ccaiesif                         No       0/0       Keep    Down
ccanet6                          No       0/0       Keep    Down
iesBundle                        No       0/0       Keep    Up
spokeSDP-test                    No       0/0       Keep    Down
test                             No       0/0       Keep    Up
test1                            No       0/0       Keep    Up
test2                            No       0/0       Keep    Up
testA                            No       0/0       Keep    Up
testB                            No       0/0       Keep    Up
testIES                          No       0/0       Keep    Up
to-web                           No       0/0       Keep    Up
-------------------------------------------------------------------
Interfaces: 11
===================================================================
A:ALA-48>show>router>dhcp#
 
 
*A:vsim-2# show router 500 dhcp summary 
===============================================================================
DHCP Summary (Service: 500)
===============================================================================
Interface Name                   Arp      Leases Per Interface/ Info    Admin
  SapId/Sdp                      Populate Per Sap Limit         Option  State
-------------------------------------------------------------------------------
g1                               No       1/1                   Keep    Up
  sap:1/1/7                               1/1                           
l1                               No       0/0                   Keep    Down
-------------------------------------------------------------------------------
Interfaces: 2
===============================================================================
*A:vsim-2# 

Table 52 describes DHCP summary output field descriptions.

Table 52:  DHCP Summary Field Descriptions 

Label

Description  

Interface Name

The name of the router interface

ARP Populate

ARP populate is enabled or disabled

Used/Provided

The number of used and provided DHCP leases

Info Option

Option 82 processing is enabled or disabled on the interface

Admin State

The administrative state

Sample Output
*A:vsim-2# show router 500 dhcp6 summary 
===============================================================================
DHCP6 Summary (Service: 500)
===============================================================================
-------------------------------------------------------------------------------
Service Interfaces
-------------------------------------------------------------------------------
Interface Name                   Nbr      Used/Max Relay     Admin  Oper Relay
  SapId                          Resol.   Used/Max Server    Admin  Oper Server
-------------------------------------------------------------------------------
l1                               No          0/0             Down   Down
                                             0/8000          Down   Down
-------------------------------------------------------------------------------
Interfaces: 1
-------------------------------------------------------------------------------
-------------------------------------------------------------------------------
Routed CO Interfaces
-------------------------------------------------------------------------------
Interface Name                          Used                Admin (proxy/relay)
  SapId                                                     
-------------------------------------------------------------------------------
g1                                      1                   Down/Up
  sap:1/1/7                             1                   
-------------------------------------------------------------------------------
Interfaces: 1                           1                   
-------------------------------------------------------------------------------
===============================================================================
*A:vsim-2# 
 
*A:vsim-2# show router 500 dhcp6 local-dhcp-server "d6" summary 
===============================================================================
DHCP server d6  router 500
===============================================================================
Admin State            : inService
Operational State      : inService
Persistency State      : shutdown
Use Link Address       : enabled (scope subnet)
Use pool from client   : disabled
Creation Origin        : manual
Lease Hold Time        : 0h0m0s
Lease Hold Time For    : N/A
User-ident             : duid
Interface-id-mapping   : disabled
Ignore-rapid-commit    : disabled
Allow-lease-query      : disabled
Failover Admin State   : outOfService
Failover Oper State    : shutdown
Failover Persist Key   : N/A
Administrative MCLT    : 0h10m0s
Operational MCLT       : 0h10m0s
Startup wait time      : 0h2m0s
Partner down delay     : 23h59m59s
  Ignore MCLT          : disabled
                                      
-------------------------------------------------------------------------------
Pool name : v6-1
-------------------------------------------------------------------------------
Failover Admin State   : inService
Failover Oper State    : preNormal
Failover Persist Key   : N/A
Time Left              : 0h4m16s before state transition
Administrative MCLT    : 0h10m0s
Operational MCLT       : 0h10m0s
Startup wait time      : 0h2m0s
Partner down delay     : 23h59m59s
  Ignore MCLT          : disabled
-------------------------------------------------------------------------------
Prefix
                                     Stable   Declined Advert   Rem-pend Drain
-------------------------------------------------------------------------------
2001:dead:1::/56
                                (L)  1        0        0        0        N
2001:dead:2::/56
                                (R)  0        0        0        0        N
Totals for pool                      1        0        0        0        
-------------------------------------------------------------------------------
Totals for server                    1        0        0        0        
-------------------------------------------------------------------------------
Interface associations
Interface                        Admin
-------------------------------------------------------------------------------
l1                               Up
-------------------------------------------------------------------------------
Local Address Assignment associations
Group interface                  Admin
-------------------------------------------------------------------------------
===============================================================================
*A:vsim-2#

Table 53 describes DHCP6 summary output fields.

Table 53:  DHCP6 Summary Fields 

Label

Description  

Interface Name

The name of the router interface

ARP Populate

ARP populate is enabled or disabled

Used/Provided

The number of used and provided DHCP leases

Info Option

Option 82 processing enabled or disabled on the interface

Admin State

The administrative state

dhcp6

Syntax 
dhcp6
Context 
show>router
Description 

This command enables the context to display DHCP6 related information.

interface-id-mapping

Syntax 
interface-id-mapping
Context 
show>router>dhcp6>local-dhcp-server
Description 

This command displays information about the DHCPv6 server that uses a unique /64 prefix per interface-ID options combination.

Output 

The following output is an example of interface ID mapping information.

Sample Output
show router 600 dhcp6 local-dhcp-server "d6" interface-id-mapping 
===============================================================================
Interface-ID Mappings for DHCPv6 server d6
===============================================================================
Mapped Prefix      : 2001:AAAA::/64
Relay Interface ID : 1/1/10
LDRA Interface ID  : (Not Specified)
Active Leases      : 2001:AAAA::1 (stable)
===============================================================================
1 prefix found
===============================================================================
 

Table 54 describes interface ID mapping field descriptions.

Table 54:  Interface ID Mapping Field Descriptions  

Field

Description

Mapped Prefix

The mapped prefix

Relay Interface ID

The value of the Interface-ID Option assigned by the DHCPv6 Relay Agent

LDRA Interface ID

The value of the Interface-ID Option assigned by the Lightweight DHCPv6 Relay Agent

Active Leases

The number of active leases

No. of prefixes found

The total number of prefixes found.

leases

Syntax 
leases [ipv6-address/prefix-length] [type] [state] [detail]
Context 
show>router>dhcp6>local-dhcp-server
Description 

This command displays the DHCP6 leases.

Parameters 
ipv6-address—
Specifies the base IP address of the subnet. This address must be unique within the subnet and specified in dotted decimal notation. Allowed values are IP addresses in the range 1.0.0.0 – 223.255.255.255 (with support of /31 subnets).
mask—
The subnet mask in dotted decimal notation
Values—
0 to 32

 

type—
Displays the lease type
Values—
pd, wan-host

 

state—
Displays the state of the lease
Values—
advertised, remove-pending, held

 

detail—
Displays detailed information of all leases that fall into the indicated subnet.

The command with no parameters shows all leases from the local user database.

Output 

The following output is an example of lease information.

Sample Output
show router 600 dhcp6 local-dhcp-server "d6" leases
===============================================================================
Leases for DHCPv6 server d6
===============================================================================
IP Address/Prefix                          Lease State       Remaining   Fail
  Link-local Address                                         LifeTime    Ctrl
-------------------------------------------------------------------------------
2001:AAAA::1/128
  FE80::220:FCFF:FE1E:CD52                 stable            23h58m52s   local
-------------------------------------------------------------------------------
1 leases found
===============================================================================
 

Table 55 describes DHCP6 lease fields.

Table 55:  DHCP6 Lease Field Descriptions  

Field

Description

IP Address/Prefix

The IP address and prefix of the lease

Link-local Address

The link local address of the lease

Lease State

The lease state of the lease

Remaining Lifetime

The remaining lifetime of the lease

Fail Ctrl

The type of failover control

No. leases found

The total number of leases

pool-ext-stats

Syntax 
pool-ext-stats [pool-name]
Context 
show>router>dhcp6>server
Description 

This command displays extended statistics per DHCPv6 pool in local DHCPv6 server.

The following statistics are included in output:

  1. The number of stable leases in the pool
  2. The number of provisioned /64 address block in the pool
  3. The number of used /64 address block in the pool
  4. The number of free /64 address block in the pool
  5. The percentage of used address (with /64 address block)
  6. The percentage of free address (with /64 address block)

For each statistic (except for Provisioned Addresses), there is current value and peak value, peak value is the highest value since pool creation or last reset via command “clear router <rt-id> dhcp6 local-dhcp-server <svr-name> pool-ext-stats”.

Parameters 
pool-name—
Specifies the name of DHCPv6 local server pool
Output 

The following output is an example of subnet statistics information.

Sample Output
show router 500 dhcp6 local-dhcp-server "d6" pool-ext-stats "pool-v6" 
===============================================================================
Extended pool statistics for server "d6"
===============================================================================
                           Current         Peak            TimeStamp
-------------------------------------------------------------------------------
Pool                       pool-v6
Local:
  Stable Leases            0               0               01/07/2013 19:54:52
  Provisioned Blks         4                               
  Used Blks                0               0               01/07/2013 19:54:52
  Free Blks                4               4               01/07/2013 19:54:52
  Used Pct                 0               0               01/07/2013 19:54:52
  Free Pct                 100             100             01/07/2013 19:54:52
Last Reset Time                                            01/07/2013 19:54:52
-------------------------------------------------------------------------------
Number of entries          1
===============================================================================
 

Table 56 describes DHCP6 extended pool statistics output fields.

Table 56:  DHCP6 Pool Ext Stats Field Descriptions  

Field

Description

Current

The current pool statistics

Peak

The peak value since the last reset

TimeStamp

The date and time of the last reset

Pool

The pool name

Stable Leases

The number of stable leases

Provisioned Blks

The number of provisioned blocks in this pool

Free Blks

The number of free blocks in this pool

Used Pct

The percentage of extended statistics in use

Free Pct

The percentage of /64 blocks currently unused

Last Reset Time

The date and time of the last reset

Number of entries

The total number of entries

pool-stats

Syntax 
pool-stats [pool-name]
Context 
show>router>dhcp6>server
Description 

This command displays pool statistics.

Parameters 
pool-name—
Specifies the name of DHCPv6 local server pool.
Output 

The following output is an example of pool statistics information.

Sample Output
*A:vsim-2# show router 500 dhcp6 local-dhcp-server "d6" pool-stats 
===============================================================================
DHCPv6 server pool statistics
===============================================================================
Pool                          : v6-1
-------------------------------------------------------------------------------
Dropped Int no prefix WAN     : 0
Dropped Int no prefix SLAAC   : 0
===============================================================================
*A:vsim-2#  
*A:vsim-2# show router 500 dhcp local-dhcp-server "d4" failover-
failover-pool-stats     failover-server-stats
*A:vsim-2# show router 500 dhcp local-dhcp-server "d4" failover-pool-stats 
==================================================================
Failover config for pool         v4-1
==================================================================
Failover Admin State             inService
Failover Oper State              normal
Failover Persist Key             0xFFFFFFFF
Administrative MCLT              0h10m0s
Operational MCLT                 0h10m0s
Startup Wait Time                0h2m0s
Partner Down Delay               23h59m59s
  Ignore MCLT                    disabled
Failover statistics for pool     v4-1
------------------------------------------------------------------
Dropped Invalid Packets          0
Failover Shutdown                0
Lease Already Expired            0
Maximum Lease Count Reached      0
Subnet Not Found                 0
Range Not Found                  0
Host Conflict                    0
Address Conflict                 0
Peer Conflict                    0
Persistence Congestion           0    
No Lease Hold Time Configured    0
Lease Not Found                  0
------------------------------------------------------------------
Number of pools found            1
==================================================================
*A:vsim-2# 

Table 57 describes pool statistics output field descriptions.

Table 57:  Failover Pool Statistics Field Descriptions 

Field

Description

Failover Admin State

Identifiers the failover state of the DHCP server instance

inService — The failover admin state is in service

outOfService — The failover admin state is out of service

Failover Oper State

The operational state of a DHCP server instance

Failover Persist Key

The maximum amount of time that one server can extend a lease for a client's binding beyond the time known by the partner server

Administrative MCLT

The administrative Maximum Client Lead Time (MCLT)

Operational MCLT

Indicates the operational MCLT

Startup Wait Time

The startup wait time. The startup wait time is the time that one IP address pool attempts to contact the partner IP address pool. During this time, the IP address pool is unresponsive to DHCP client requests.

Partner Down Delay

The minimum safe-time after the beginning of COMMUNICATIONS-INTERRUPTED state.

After the expiry of this time, the server enters the PARTNER-DOWN state.

Ignore McLT

The ignore McLT status. If, after the transition COMMUNICATIONS-INTERRUPTED-to-PARTNER-DOWN state, the DHCP server instance ignores the safety period with a duration of Maximum Client Lead Time; a ‘true’ value has the effect that the DHCP server starts offering IP addresses from the partner's scope immediately after this transition, without waiting for existing leases allocated by the partner and not known by this system to time out.

A ‘true’ value increases the risk that duplicate addresses are offered; if the transition to PARTNER-DOWN state is likely to be caused by a failure of the partner system rather than a communications problem, this risk is reduced.

Failover statistics for pool

The failover statistics for each pool

Dropped Invalid Packets

The number of BNDUPD packets that were dropped because the packet was malformed

Failover Shutdown

The number of BNDUPD packets that were dropped because the failover state if the DHCP server instance is shut down

Lease Already Expired

The number of BNDUPD packets that were dropped because the corresponding lease has expired

Maximum Lease Count Reached

The number of BNDUPD packets that were dropped because the maximum number of leases were reached

Subnet Not Found

The number of BNDUPD packets that were dropped because a valid subnet could not be found for the lease

Range Not Found

The number of BNDUPD packets that were dropped because a valid include range could not be found for the lease.

Host Conflict

The number of BNDUPD packets that were dropped because this DHCP server instance has already leased this address to another host

Address Conflict

The number of BNDUPD packets that were dropped because this DHCP server instance has already leased another address to this host

Peer Conflict

The number of BNDUPD packets that were dropped because the failover peer has leased an address within a subnet range of which the failover control is set to local on this local DHCP server instance

Persist Congestion

The number of BNDUPD packets that were dropped because of persistence congestion on this DHCP server instance

No Lease Hold Time Configured

The number of BNDUPD packets that were dropped because the lease hold time is zero on this DHCP server instance

Lease Not Found

The number of Binding Database Update (BNDUPD) remove packets were dropped because the corresponding lease could not be found.

Number of pools found

The total number of pools found

pool-threshold-stats

Syntax 
pool-threshold-stats [pool-name] detail [format {exact | scientific}]
pool-threshold-stats [pool-name]
Context 
show>router>dhcp6>server
Description 

This commands displays pool level threshold stats of local DHCPv6 server. A minimum-free threshold needs to be configured before system collects threshold stats for the prefix.

The stats for each threshold are calculated based on the configured minimum-free prefix length.

For example, a /59 prefix is provision in the local DHCPv6 server, and the server allocated two PD leases, one /62 and one /63. And there is a /63 minimum threshold configured. The threshold stats are calculated based on /63 as the base unit (block). Then the value of current used block would be 3 because there is one /62 lease and one /63 lease, that equals to a total of three /63.

Parameters 
pool-name—
Specifies the name of the pool in local DHCPv6 server.
detail—
Displays detailed output.
format—
Specifies the format in the display to be either exact or scientific.
Output 

The following output is an example of pool threshold statistics information.

Sample Output
show router 500 dhcp6 local-dhcp-server "d6" pool-threshold-stats "1" 
===============================================================================
Server "d6"
===============================================================================
  Operational state         : inService
-------------------------------------------------------------------------------
Pool                        : 1
-------------------------------------------------------------------------------
  Stable leases             : 2
  Advertised leases         : 0
  -----------------------------------------------------------------------------
  Threshold   Used   Peak   Too low   Depleted   Peak timestamp
  -----------------------------------------------------------------------------
  /62         25%    25%    N         N          01/21/2015 21:52:12
  /63         19%    19%    N         N          01/21/2015 21:52:12
 

The command shown above displays an overview of pool level thresholds in the specified pool:

  1. The Peak field indicates the peak value of used
  2. The Too low field indicate if the configured minimum-free threshold is exceeded
  3. The Depleted field indicate if there is no available prefix with the length in the provisioned prefix
  4. The Peak timestamp field indicates the time of peak used value
 
show router 500 dhcp6 local-dhcp-server "d6" pool-threshold-stats "1" detail 
===============================================================================
Server "d6"
===============================================================================
  Operational state         : inService
-------------------------------------------------------------------------------
Pool                        : 1
-------------------------------------------------------------------------------
  Stable leases             : 2
  Advertised leases         : 0
  -----------------------------------------------------------------------------
  Threshold                 : /62
  -----------------------------------------------------------------------------
  Current Provisioned Blks  : 8.000000x10^0
  Current Used Blks         : 2.000000x10^0
  Current Free Blks         : 6.000000x10^0
  Current Used Percent      : 25%
  Current Used Peak Blks    : 2.000000x10^0
  Current Used Peak Percent : 25%
  Current Used Peak Time    : 01/21/2015 21:52:12
  Current Free Percent      : 75%
  Current Free Too Low      : N
  Current Free Depleted     : N
  Local Provisioned Blks    : 8.000000x10^0
  Local Used Blks           : 2.000000x10^0
  Local Free Blks           : 6.000000x10^0
  Local Used Peak Blks      : 2.000000x10^0
  Local Used Peak Percent   : 25%
  Local Used Peak Time      : 01/21/2015 21:52:12
  Remote Provisioned Blks   : 0.000000x10^0
  Remote Used Blks          : 0.000000x10^0
  Remote Free Blks          : 0.000000x10^0
  Remote Used Peak Blks     : 0.000000x10^0
  Remote Used Peak Percent  : 0%
  Remote Used Peak Time     : 01/21/2015 21:47:39
  Peak Reset Time           : 01/21/2015 21:47:39
  Valid Data                : Y
  -----------------------------------------------------------------------------
  Threshold                 : /63
  -----------------------------------------------------------------------------
  Current Provisioned Blks  : 1.600000x10^1
  Current Used Blks         : 3.000000x10^0
  Current Free Blks         : 1.300000x10^1
  Current Used Percent      : 19%
  Current Used Peak Blks    : 3.000000x10^0
  Current Used Peak Percent : 19%
  Current Used Peak Time    : 01/21/2015 21:52:12
  Current Free Percent      : 81%
  Current Free Too Low      : N
  Current Free Depleted     : N       
  Local Provisioned Blks    : 1.600000x10^1
  Local Used Blks           : 3.000000x10^0
  Local Free Blks           : 1.300000x10^1
  Local Used Peak Blks      : 3.000000x10^0
  Local Used Peak Percent   : 19%
  Local Used Peak Time      : 01/21/2015 21:52:12
  Remote Provisioned Blks   : 0.000000x10^0
  Remote Used Blks          : 0.000000x10^0
  Remote Free Blks          : 0.000000x10^0
  Remote Used Peak Blks     : 0.000000x10^0
  Remote Used Peak Percent  : 0%
  Remote Used Peak Time     : 01/21/2015 21:47:39
  Peak Reset Time           : 01/21/2015 21:47:39
  Valid Data                : Y
 

The above command displays detailed statistics of all pool level thresholds in the specified pool:

  1. Blks in the output means the minimum free prefix length.
  2. Valid Data output indicates whether the data you see is valid or not. The data is invalid when a background stats update is scheduled or busy.

Table 58 describes pool threshold statistics output fields.

Table 58:  Pool Threshold Statistics Field Descriptions   

Field

Description

Operational state

The operational state of the local DHCP server instance

unknown — The operational state is unknown

inService — The operational state is in service

outOfService — The operational state is out of service

transition — The operational state is in transition

waitPersistence — The DHCP server instance is waiting for a persistence action to complete.

Pool

The pool ID

Stable Leases

The number of stable leases

Advertised leases

The number of advertised leases

Threshold

The prefix level threshold

Current Provisioned Blks

The number of provisioned blocks in this pool

Current Used Blks

The number of used blocks in this pool

Current Free Blks

The number of free blocks in this pool

Current Used Percent

The percentage of used prefixes with the minimum free threshold length in the pool compared to the number of provisioned prefixes

Current Used Peak Blks

A 64-bit word of the peak value of the number of used blocks in the pool with a prefix length

Current Used Peak Percent

The peak value of the number of used prefixes with the minimum free threshold length in the pool as a percentage of the provisioned prefixes. This depends on the current failover state of the DHCP server or pool

Current Used Peak Time

The time at which the peak value of the number of used prefixes in the pool was reached

Current Free Percent

The percentage of free prefixes with the minimum free threshold length in the pool compared to the number of provisioned prefixes. This depends on the current failover state of the DHCP server or pool

Current Free Too Low

The number of free prefixes with the minimum free threshold length available in the pool that is below the configured number of prefixes with the minimum free threshold length

Current Free Depleted

The number of prefixes with the minimum free threshold length available in the pool

Local Provisioned Blks

A 64-bit word of the number of provisioned prefixes with the minimum free threshold length local in the pool

Local Used Blks

A 64-bit word of the number of used prefixes with the minimum free threshold length local in the pool

Local Free Blks

A 64-bit word of the number of free prefixes with the minimum free threshold length local in the pool

Local Used Peak Blks

A 64-bit word of the peak value of the number of used prefixes with the minimum free threshold length local in the pool

Local Used Peak Percent

The peak value of the number of used prefixes with the minimum free threshold length local in the pool as a percentage of the provisioned prefixes

Local Used Peak Time

The time at which the peak value of the number of used prefixes local in the pool was reached

Remote Provisioned Blks

A 64-bit word of the number of provisioned prefixes with the minimum free threshold length remote in the pool

Remote Used Blks

A 64-bit word of the number of used prefixes with the minimum free threshold length remote in the pool

Remote Free Blks

A 64-bit word of the number of free prefixes with the minimum free threshold length remote in the pool

prefix-ext-stats

Syntax 
prefix-ext-stats ipv6-address/prefix-length
prefix-ext-stats pool pool-name
Context 
show>router>dhcp6>server
Description 

This command displays extended statistics per DHCPv6 prefix in local DHCPv6 server.

The following statistics are included in output:

  1. The number of stable leases in the prefix
  2. The number of provisioned /64 address block in the prefix
  3. The number of used /64 address block in the prefix
  4. The number of free /64 address block in the prefix
  5. The percentage of used address (with /64 address block)
  6. The percentage of free address (with /64 address block)

For each statistic (except for Provisioned Addresses), there is current value and peak value, peak value is the highest value since prefix creation or last reset via command clear>router rt-id>dhcp6>local-dhcp-server svr-name>prefix-ext-stats.

When the pool parameter is used, the statistics of each prefix in the pool will be displayed.

Parameters 
ipv6-address/prefix-length—
Specifies the IPv6 prefix
pool-name—
The name of DHCPv6 local server pool
Output 

The following output is an example of prefix extended stats information.

Sample Output
show router 500 dhcp6 local-dhcp-server "d6" prefix-ext-stats 2001:ABCD::/62 
===============================================================================
Extended statistics for prefix 2001:ABCD::/62
===============================================================================
                           Current         Peak            TimeStamp
-------------------------------------------------------------------------------
Local:
  Failover Oper State      Active                          
  Stable Leases            0               0               01/07/2013 19:54:52
  Provisioned Blks         4                               
  Used Blks                0               0               01/07/2013 19:54:52
  Free Blks                4               4               01/07/2013 19:54:52
  Used Pct                 0               0               01/07/2013 19:54:52
  Free Pct                 100             100             01/07/2013 19:54:52
Last Reset Time                                            01/07/2013 19:54:52
-------------------------------------------------------------------------------
Number of entries          1
===============================================================================
 

Table 59 describes extended prefix statistics output fields.

Table 59:  Prefix Extended Statistics Field Descriptions  

Field

Description

Current

The current extended prefix statistics

Peak

The peak value since the last reset

TimeStamp

The date and time of the last reset

Failover Oper State

The operational state of the DHCP specified prefix

Stable Leases

The number of stable leases

Provisioned Blks

The number of provisioned blocks

Used Blks

The number of used blocks

Free Blks

The number of free blocks

Used Pct

The percentage of extended prefixes in use

Free Pct

The percentage of free prefixes in use

Last Reset Time

The date and time of the last reset

Number of entries

The total number of entries

prefix-stats

Syntax 
prefix-stats ipv6-address/prefix-length
prefix-stats pool pool-name
Context 
show>router>dhcp6>local-dhcp-server
Description 

This command displays prefix statistics.

Parameters 
ipv6-address—
Specifies the base IP address of the subnet. This address must be unique within the subnet and specified in dotted decimal notation. Allowed values are IP addresses in the range 1.0.0.0 – 223.255.255.255 (with support of /31 subnets).
pool-name—
Specifies the name of DHCPv6 local server pool

prefix-threshold-stats

Syntax 
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
Context 
show>router>dhcp6>server
Description 

This commands displays prefix level threshold stats of local DHCPv6 server prefix. A minimum-free threshold needs to be configured before system collects threshold stats for the prefix.

The stats for each threshold are calculated based on the configured minimum-free prefix length.

For example, a /59 prefix is provision in the local DHCPv6 server, and the server allocated two PD leases, one /62 and one /63. And there is a /63 minimum threshold configured. The threshold stats are calculated based on /63 as the base unit (block). Then the value of the current used block would be 3 because there is one /62 lease and one /63 lease, that equals to a total three /63.

Parameters 
pool pool-name—
Specifies the name of the pool in local DHCPv6 server, up to 32 characters.
detail—
Displays detailed output statistics.
format—
Specifies that the number format in the display will be either exact or scientific.
ipv6-address/prefix-length—
Specifies the IPv6 prefix with prefix length.
Values—

ipv6-address x:x:x:x:x:x:x:x (eight 16-bit pieces)

x:x:x:x:x:x:d.d.d.d

x [0 to FFFF]H

d [0 to 255]D

prefix-length [1 to 128]

 

Output 

The following output is an example of prefix threshold information.

Sample Output
show router 500 dhcp6 local-dhcp-server "d6" leases                          
===============================================================================
Leases for DHCPv6 server d6
===============================================================================
IP Address/Prefix                          Lease State       Remaining   Fail
  Link-local Address                                         LifeTime    Ctrl
-------------------------------------------------------------------------------
8888:0:0:ffe0:db8:/62
  fe80::3:ffff:fe00:db8:111                    stable            18h19m2s    local
8888:0:0:ffe4::/63
  fe80::3:ffff:fe00:db8:211                    stable            19h49m37s   local
-------------------------------------------------------------------------------
2 leases found
===============================================================================
show router 500 dhcp6 local-dhcp-server "d6" prefix-threshold-stats pool "1" 
===============================================================================
Server "d6"
===============================================================================
  Operational state         : inService
-------------------------------------------------------------------------------
Pool                        : 1
-------------------------------------------------------------------------------
  Stable leases             : 2
  Advertised leases         : 0
-------------------------------------------------------------------------------
Prefix                      : 8888:0:0:ffe0:db8:/59
-------------------------------------------------------------------------------
  Stable leases             : 2
  Advertised leases         : 0
  Draining                  : N
  -----------------------------------------------------------------------------
  Threshold   Used   Peak   Too low   Depleted   Peak timestamp
  -----------------------------------------------------------------------------
  /62         25%    25%    Y         N          01/20/2015 23:51:36
  /63         19%    19%    N         N          01/21/2015 05:00:53
===============================================================================

The command shown above displays an overview of prefix level thresholds in the specified pool:

  1. The Peak field indicates the peak value of used.
  2. The Too low field indicate if the configured minimum-free threshold is exceeded.
  3. The Depleted field indicate if there is no available prefix with the length in the provisioned prefix.
  4. The Peak timestamp field indicates the time of peak used value.
 
show router 500 dhcp6 local-dhcp-server "d6" prefix-threshold-stats pool "1" detail 
===============================================================================
Server "d6"
===============================================================================
  Operational state         : inService
-------------------------------------------------------------------------------
Pool                        : 1
-------------------------------------------------------------------------------
  Stable leases             : 2
  Advertised leases         : 0
-------------------------------------------------------------------------------
Prefix                      : 8888:0:0:ffe0::/59
-------------------------------------------------------------------------------
  Stable leases             : 2
  Advertised leases         : 0
  Draining                  : N
  -----------------------------------------------------------------------------
  Threshold                 : /62
  -----------------------------------------------------------------------------
  Current Provisioned Blks  : 8.000000x10^0
  Current Used Blks         : 2.000000x10^0
  Current Free Blks         : 6.000000x10^0
  Current Used Percent      : 25%
  Current Used Peak Blks    : 2.000000x10^0
  Current Used Peak Percent : 25%     
  Current Used Peak Time    : 01/21/2015 21:59:02
  Current Free Percent      : 75%
  Current Free Too Low      : N
  Current Free Depleted     : N
  Local Provisioned Blks    : 8.000000x10^0
  Local Used Blks           : 2.000000x10^0
  Local Free Blks           : 6.000000x10^0
  Local Used Peak Blks      : 2.000000x10^0
  Local Used Peak Percent   : 25%
  Local Used Peak Time      : 01/21/2015 21:59:02
  Remote Provisioned Blks   : 0.000000x10^0
  Remote Used Blks          : 0.000000x10^0
  Remote Free Blks          : 0.000000x10^0
  Remote Used Peak Blks     : 0.000000x10^0
  Remote Used Peak Percent  : 0%
  Remote Used Peak Time     : 01/21/2015 21:59:02
  Peak Reset Time           : 01/21/2015 21:59:02
  Valid Data                : Y
  -----------------------------------------------------------------------------
  Threshold                 : /63
  -----------------------------------------------------------------------------
  Current Provisioned Blks  : 1.600000x10^1
  Current Used Blks         : 3.000000x10^0
  Current Free Blks         : 1.300000x10^1
  Current Used Percent      : 19%     
  Current Used Peak Blks    : 3.000000x10^0
  Current Used Peak Percent : 19%
  Current Used Peak Time    : 01/21/2015 21:59:13
  Current Free Percent      : 81%
  Current Free Too Low      : N
  Current Free Depleted     : N
  Local Provisioned Blks    : 1.600000x10^1
  Local Used Blks           : 3.000000x10^0
  Local Free Blks           : 1.300000x10^1
  Local Used Peak Blks      : 3.000000x10^0
  Local Used Peak Percent   : 19%
  Local Used Peak Time      : 01/21/2015 21:59:13
  Remote Provisioned Blks   : 0.000000x10^0
  Remote Used Blks          : 0.000000x10^0
  Remote Free Blks          : 0.000000x10^0
  Remote Used Peak Blks     : 0.000000x10^0
  Remote Used Peak Percent  : 0%
  Remote Used Peak Time     : 01/21/2015 21:59:13
  Peak Reset Time           : 01/21/2015 21:59:13
  Valid Data                : Y
 

The command shown above displays detailed statistics of all prefix level thresholds in the specified pool:

  1. Blks means the minimum free prefix length.
  2. Valid Data output indicates whether the data is or is not valid. The data is invalid when a background stats update is scheduled or busy.
 
show router 500 dhcp6 local-dhcp-server "d6" prefix-threshold-
stats 8888:0:0: ffe0:db8:/59 
===============================================================================
Server "d6"
===============================================================================
  Operational state         : inService
-------------------------------------------------------------------------------
Pool                        : 1
-------------------------------------------------------------------------------
  Stable leases             : 2
  Advertised leases         : 0
-------------------------------------------------------------------------------
Prefix                      : 8888:0:0:ffe0:db8:/59
-------------------------------------------------------------------------------
  Stable leases             : 2
  Advertised leases         : 0
  Draining                  : N
  -----------------------------------------------------------------------------
  Threshold   Used   Peak   Too low   Depleted   Peak timestamp
  -----------------------------------------------------------------------------
  /62         25%    25%    N         N          01/21/2015 21:59:02
  /63         19%    19%    N         N          01/21/2015 21:59:13
 

The command shown above displays an overview of prefix level thresholds in the specified provision prefix.

show router 500 dhcp6 local-dhcp-server "d6" prefix-threshold-stats 8888:0:0:ffe0::/
59 detail 
===============================================================================
Server "d6"
===============================================================================
  Operational state         : inService
-------------------------------------------------------------------------------
Pool                        : 1
-------------------------------------------------------------------------------
  Stable leases             : 2
  Advertised leases         : 0
-------------------------------------------------------------------------------
Prefix                      : 8888:0:0:ffe0:db8:/59
-------------------------------------------------------------------------------
  Stable leases             : 2
  Advertised leases         : 0
  Draining                  : N
  -----------------------------------------------------------------------------
  Threshold                 : /62
  -----------------------------------------------------------------------------
  Current Provisioned Blks  : 8.000000x10^0
  Current Used Blks         : 2.000000x10^0
  Current Free Blks         : 6.000000x10^0
  Current Used Percent      : 25%
  Current Used Peak Blks    : 2.000000x10^0
  Current Used Peak Percent : 25%     
  Current Used Peak Time    : 01/21/2015 21:59:02
  Current Free Percent      : 75%
  Current Free Too Low      : N
  Current Free Depleted     : N
  Local Provisioned Blks    : 8.000000x10^0
  Local Used Blks           : 2.000000x10^0
  Local Free Blks           : 6.000000x10^0
  Local Used Peak Blks      : 2.000000x10^0
  Local Used Peak Percent   : 25%
  Local Used Peak Time      : 01/21/2015 21:59:02
  Remote Provisioned Blks   : 0.000000x10^0
  Remote Used Blks          : 0.000000x10^0
  Remote Free Blks          : 0.000000x10^0
  Remote Used Peak Blks     : 0.000000x10^0
  Remote Used Peak Percent  : 0%
  Remote Used Peak Time     : 01/21/2015 21:59:02
  Peak Reset Time           : 01/21/2015 21:59:02
  Valid Data                : Y
  -----------------------------------------------------------------------------
  Threshold                 : /63
  -----------------------------------------------------------------------------
  Current Provisioned Blks  : 1.600000x10^1
  Current Used Blks         : 3.000000x10^0
  Current Free Blks         : 1.300000x10^1
  Current Used Percent      : 19%     
  Current Used Peak Blks    : 3.000000x10^0
  Current Used Peak Percent : 19%
  Current Used Peak Time    : 01/21/2015 21:59:13
  Current Free Percent      : 81%
  Current Free Too Low      : N
  Current Free Depleted     : N
  Local Provisioned Blks    : 1.600000x10^1
  Local Used Blks           : 3.000000x10^0
  Local Free Blks           : 1.300000x10^1
  Local Used Peak Blks      : 3.000000x10^0
  Local Used Peak Percent   : 19%
  Local Used Peak Time      : 01/21/2015 21:59:13
  Remote Provisioned Blks   : 0.000000x10^0
  Remote Used Blks          : 0.000000x10^0
  Remote Free Blks          : 0.000000x10^0
  Remote Used Peak Blks     : 0.000000x10^0
  Remote Used Peak Percent  : 0%
  Remote Used Peak Time     : 01/21/2015 21:59:13
  Peak Reset Time           : 01/21/2015 21:59:13
  Valid Data                : Y

The command displayed above displays detailed statistics of prefix level thresholds in the specified provision prefix.

 
 

Table 60 describes prefix threshold statistics output fields.

Table 60:  Prefix Threshold Statistics Field Descriptions  

Field

Description

Operational state

The operational state of the local DHCP server instance

unknown — The operational state is unknown

inService — The operational state is in service

outOfService — The operational state is out of service

transition — The operational state is in transition

waitPersistence — The DHCP server instance is waiting for a persistence action to complete.

Pool

The number of pools in the specified prefix

Stable leases

The number of stable leases associated with the prefix

Advertised leases

The advertised leases associated with the prefix

Prefix

The specified prefix

Draining

The draining state

Y — enabled

N — disabled

Threshold

The prefix level threshold

Current Provisioned Blks

The number of provisioned blocks for this prefix

Current Used Blks

The number of used blocks for this prefix

Current Free Blks

The number of free blocks for this prefix

Current Used Percent

The percentage of used prefixes with the minimum free threshold length for this prefix

Current Used Peak Blks

A 64-bit word of the peak value of the number of used blocks for this prefix

Current Used Peak Percentage

The peak value of the number of used prefixes with the minimum free threshold length in the pool as a percentage of the provisioned prefixes.

Current Used Peak Time

The time at which the peak value of the number of used prefixes in the pool was reached

Current Free Percent

The percentage of free prefixes with the minimum free threshold length in the pool compared to the number of provisioned prefixes.

Current Free Too Low

The number of free prefixes with the minimum free threshold length available in the pool that is below the configured number of prefixes with the minimum free threshold length

Current Free Depleted

The number of prefixes with the minimum free threshold length available

Local Provisioned Blks

A 64-bit word of the number of provisioned prefixes with the minimum free threshold length local

Local Used Blks

The higher 64-bits word of the number of used prefixes with the minimum free threshold length

Local Free Blks

A 64-bit word of the number of free prefixes with the minimum free threshold length

Local Used Peak Blks

A 64-bit word of the peak value of the number of used prefixes with the minimum free threshold length

Local Used Peak Percent

The peak value of the number of used prefixes with the minimum free threshold length local in the pool as a percentage of the provisioned prefixes

Local Used Peak Time

The time at which the peak value of the number of used prefixes local in the pool was reached

Remote Provisioned Blks

A 64-bit word of the number of provisioned prefixes with the minimum free threshold length

Remote Used Blks

A 64-bit word of the number of used prefixes with the minimum free threshold length remote in the pool

Remote Free Blks

A 64-bit word of the number of free prefixes with the minimum free threshold length remote in the pool

Remote Used Peak Blks

The higher 64-bit word of the number of used prefixes with the minimum free threshold length

Remote Used Peak Percent

The peak value of the number of used prefixes with the minimum free threshold length remote in the pool as a percentage of the provisioned prefixes

Remote Used Peak Time

The time at which the peak value of the number of used prefixes remote in the pool was reached.

Peak Reset Time

The time at which the peak values have been reset

Valid Dada

The actual status of the threshold statistics data of the pool.

Y — the data is up to date and may be used.

N — the data is being recalculated in the background and is not stable for further use

statistics

Syntax 
statistics [interface ip-int-name]
Context 
show>router>dhcp6
show>service>id>dhcp6
Description 

This command displays statistics for DHCP6 relay and snooping.

Parameters 
ip-int-name—
Specifies to display interface name information
Output 

The following output is an example of DHCP6 statistics information.

Sample Output
A:ALA-A# show router 1000 dhcp6 statistics 
===================================================================
DHCP6 Global Statistics (Service: 1000)
===================================================================
Rx Packets                           : 16000                       
Tx Packets                           : 15041                       
Rx Malformed Packets                 : 0                           
Rx Untrusted Packets                 : 0                           
Client Packets Discarded             : 423                         
Client Packets Relayed               : 0                           
Client Packets Snooped               : 0                           
Client Packets Proxied (RADIUS)      : 0                           
Client Packets Proxied (Lease-Split) : 0                           
Server Packets Discarded             : 0                           
Server Packets Relayed               : 0                           
Server Packets Snooped               : 0                           
DHCP RELEASEs Spoofed                : 0                           
DHCP FORCERENEWs Spoofed             : 0                           
===================================================================
A:ALA-A# 

*A:cses-V26# show service id 8 dhcp6 statistics
====================================================================
DHCP Statistics, service 8, all interfaces
====================================================================
Packets received                     : 0
Packets transmitted                  : 0
Packets dropped                      : 0
====================================================================
*A:cses-V26#

Table 61 describes DHCP6 output statistics.

Table 61:  DHCP6 Statistics Field Descriptions  

Field

Description

Rx Packets

The number of packets received

Tx Packets

The number of packets sent

Rx Malformed Packets

The number of malformed packets received from the DHCP6 clients

Rx Untrusted Packets

The number of untrusted packets received from the DHCP clients

Client Packets Discarded

The number of packets received from the DHCP clients that were discarded

Client Packets Relayed

The number of packets received from the DHCP clients that were forwarded

Client Packets Snooped

The number of packets received from the DHCP clients that were snooped

Client Packets Proxied (RADIUS)

The number of client packets proxied through RADIUS

Client Packets Proxied (Lease-Split)

The number of client packets proxied through a lease split

Server Packets Discarded

The number of discarded server packets

Server Packets Relayed

The number of relayed server packets

Server Packets Snooped

The number of snooped server packets

DHCP RELEASEs Spoofed

The number of spoofed DHCP releases

DHCP FORCERENEWs Spoofed

The number of spoofed FORCERENEW messages

lease-state

Syntax 
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]
Context 
show>service>id>dhcp
Description 

This command displays DHCP lease state information. The wholesaler service-id parameter is applicable only in the VPRN context.

Note:

The wholesaler service-id parameter is applicable only in the VPRN context (VPRN is supported by the 7750 SR only).

Parameters 
service-id—
Specifies the service ID of the wholesaler. When specified in this context, SAP, SDP, interface, IP address and MAC parameters are ignored. This parameter applies only to the 7750 SR.
Values—
service-id: 1 to 214748364
svc-name: specifies a string, up to 64 characters

 

sap-id—
Specifies the physical port identifier portion of the SAP definition
sdp-id—
Specifies the SDP identifier
Values—
1 to 17407

 

vc-id—
Specifies the virtual circuit identifier. This value is used to validate the VC ID portion of each mesh SDP binding defined in the service. The default value of this object is equal to the service ID.
Values—
1 — 4294967295

 

interface-name—
Shows the interface name, up to 32 characters
ip-address[/mask]—
Shows information for the specified IP address and mask
port-id—
Specifies the DHCP lease state local specifies that the DHCP lease state is learned by either a SAP or SDP. When the value is SAP, the value indicates the SAP for which this entry contains information.
chaddr—
Specifies the MA address of the DHCP lease state
interface-name—
Shows information for the specified IP interface
detail—
Displays detailed lease state information
inter-dest-id—
Indicates the intermediate destination identifier received from either the DHCP or the RADIUS server or the local user database
session—
Shows DHCPv4 lease states for hosts that are associated with an IPoE session or for hosts that are not associated with an IPoE session
Values—
none, ipoe

 

detail—
Displays detailed information
Output 

The following output is an example of lease state information.

Sample Output
*A:ALA-48>config# show service id 101 dhcp lease-state
===============================================================================
DHCP lease state table, service 101
===============================================================================
IP Address      Mac Address       Sap/Sdp Id          Remaining  Lease    MC
                                                      LifeTime   Origin   Stdby
-------------------------------------------------------------------------------
10.1.1.52      00:00:1f:bd:00:bb lag-1:101           00h02m56s  DHCP-R
10.3.2.62      00:00:1f:bd:00:c6 lag-1:105           00h02m59s  RADIUS
-------------------------------------------------------------------------------
Number of lease states : 2
===============================================================================
*A:ALA-48>config#
 
 
*A:ALA-48>config# show service id 105 dhcp lease-state  wholesaler 101
===============================================================================
DHCP lease state table, service 105
===============================================================================
IP Address      Mac Address       Sap/Sdp Id          Remaining  Lease    MC
                                                      LifeTime   Origin   Stdby
-------------------------------------------------------------------------------
Wholesaler 101 Leases
-------------------------------------------------------------------------------
10.3.2.62      00:00:1f:bd:00:c6 lag-1:105           00h00m39s  RADIUS
-------------------------------------------------------------------------------
Number of lease states : 1
===============================================================================
*A:ALA-48>config#

Table 62 describes the output fields for DHCP summary.

Table 62:  DHCP Summary Field Descriptions 

Label

Description  

Interface Name

The name of the router interface

ARP Populate

The ARP populate is enabled or disabled

Used/Provided

The number of used and provided DHCP leases

Info Option

Option 82 processing is enabled or disabled on the interface

Admin State

The administrative state

statistics

Syntax 
statistics [[sap sap-id] | [sdp sdp-id:vc-id] | [interface interface-name]]
Context 
show>service>id>dhcp
Description 

This command displays DHCP relay statistics.

Parameters 
ip-int-name—
Displays DHCP statistics on the specified interface.
interface-name—
Displays DHCP statistics for the specified interface name.
sap-id—
Displays DHCP statistics for the specified SAP.
Output 

The following output is an example of DHCP statistics information.

Sample Output
*A:ALA-48# show service id 88 dhcp statistics interface SpokeTerm
===================================================================
DHCP Statistics for interface SpokeTerm
===================================================================
Rx Packets                           : 0
Tx Packets                           : 0
Rx Malformed Packets                 : 0
Rx Untrusted Packets                 : 0
Client Packets Discarded             : 0
Client Packets Relayed               : 0
Client Packets Snooped               : 0
Client Packets Proxied (RADIUS)      : 0
Client Packets Proxied (Lease-Split) : 0
Server Packets Discarded             : 0
Server Packets Relayed               : 0
Server Packets Snooped               : 0
DHCP RELEASEs Spoofed                : 0
DHCP FORCERENEWs Spoofed             : 0
===================================================================
*A:ALA-48#

Table 63 describes DHCP statistics output fields.

Table 63:  DHCP Statistics Field Descriptions  

Field

Description

Rx Packets

The number of received packets

Tx Packets

The number of transmitted packets

Rx Malformed

The number of malformed packets received

Rx Untrusted Packets

The number of untrusted packets received

Client Packets Discarded

The number of client packets discarded

Client Packets Relayed

The number of client packets relayed

Client Packets Snooped

The number of client packets snooped

Client Packets Proxied (RADIUS)

The number of client packets proxied through RADIUS

Client Packets Proxied (Lease-Split)

The number of client packets proxied through a lease split

Server Packets Discarded

The number of discarded server packets

Server Packets Relayed

The number of relayed server packets

Server Packets Snooped

The number of snooped server packets

DHCP RELEASEs Spoofed

The number of spoofed DHCP releases

DHCP FORCERENEWs Spoofed

The number of spoofed FORCERENEW messages

summary

Syntax 
summary
summary interface interface-name
summary saps
Context 
show>service>id>dhcp
show>service>id>dhcp6
Description 

This command displays DHCP or DHCP6 configuration summary information.

Parameters 
interface-name—
Displays summary information for the specified existing interface
saps —
Displays summary information for SAPs per interface
Output 

The following output is an example of a summary of DHCP information.

Sample Output
IES:
*A:ALA-48>show>service>id>dhcp# summary 
===========================================================
DHCP Summary, service 700
===========================================================
Sap/Sdp                Snoop  Used/       Info     Admin
                              Provided    Option   State
-----------------------------------------------------------
sap:1/1/9:0            No     0/0         Keep     Down
sap:1/1/25:0           No     0/0         Keep     Down
sdp:8:700              No     N/A         N/A      N/A
-----------------------------------------------------------
Number of Entries : 3
-----------------------------------------------------------
*A:ALA-48>show>service>id>dhcp#
 
 
VPLS:
*A:ALA-49>show>service# id 700 dhcp summary
=======================================================================
DHCP Summary, service 700
=======================================================================
Sap/Sdp                Snoop  Used/       Arp Reply   Info     Admin
                              Provided    Agent       Option   State
-----------------------------------------------------------------------
sap:1/1/9:0            No     0/0         No          Keep     Down
sdp:2:222              No     N/A         N/A         N/A      N/A
sdp:2:700              No     N/A         N/A         N/A      N/A
-----------------------------------------------------------------------
Number of Entries : 3
-----------------------------------------------------------------------
*A:ALA-49>show>service#
 

The following example is for the 7750 SR:

VPRN:
*A:ALA-49>show>service# id 1 dhcp summary
===============================================================================
DHCP Summary, service 1
===============================================================================
Interface Name                   Arp      Used/                 Info    Admin
  SapId/Sdp                      Populate Provided              Option  State
-------------------------------------------------------------------------------
SpokeSDP                         No       0/0                   Keep    Down
  sdp:spoke-3:4                           0/0
test                             No       0/0                   Keep    Down
  sap:9/1/4:50/5                          0/0
to-ce1                           No       0/0                   Keep    Up
  sap:1/1/10:1                            0/0
-------------------------------------------------------------------------------
Interfaces: 3
===============================================================================
*A:ALA-49>show>service#
 
*A:ALA-48# show service id 88 dhcp summary saps
===============================================================================
DHCP Summary, service 88
===============================================================================
Interface Name                   Arp      Used/                 Info    Admin
  SapId/Sdp                      Populate Provided              Option  State
-------------------------------------------------------------------------------
SpokeTerm                        No       0/0                   Keep    Up
  sdp:spoke-3:3                           0/0
new-if                           No       0/1                   Keep    Up
  sap:1/2/19:0                            0/1
test123                          No       0/0                   Keep    Up
  sap:3/2/4:50/5                          0/0
testabc                          No       0/0                   Keep    Up
  sap:1/2/20:0                            0/0
-------------------------------------------------------------------------------
Interfaces: 4
===============================================================================
*A:ALA-48#
 
 
*A:ALA-48# show service id 88 dhcp summary interface SpokeTerm
===============================================================================
DHCP Summary, service 88
===============================================================================
Interface Name                   Arp      Used/                 Info    Admin
  SapId/Sdp                      Populate Provided              Option  State
-------------------------------------------------------------------------------
SpokeTerm                        No       0/0                   Keep    Up
  sdp:spoke-3:3                           0/0
-------------------------------------------------------------------------------
Interfaces: 1
===============================================================================
*A:ALA-48#

Table 64 describes the DHCP summary output fields.

Table 64:  DHCP Summary Field Descriptions  

Field

Description

Interface Name

The DHCP interface name

Arp Populate

The state of ARP populate

Used/Provided

The number used or provided

Info Option

The info option

Admin State

The administrative state of the interface

Interfaces

The total number of interfaces

lease-state

Syntax 
lease-state [detail] [wholesaler service-id] [session {none | ipoe | ppp}] [router-advertisement-policy policy-name]
lease-state [detail] interface interface-name [wholesaler service-id] [session {none | ipoe | ppp}] [router-advertisement-policy policy-name]
lease-state [detail] ipv6-address ipv6-prefix[/prefix-length] [wholesaler service-id] [session {none | ipoe | ppp}] [router-advertisement-policy policy-name]
lease-state [detail] mac ieee-address [wholesaler service-id] [session {none | ipoe | ppp}] [router-advertisement-policy policy-name]
Context 
show>service>id>dhcp6
Description 

This command displays DHCPv6 lease state information.

Note:

The wholesaler service-id parameter is applicable only in the VPRN context.

Parameters 
detail—
Displays detailed lease state information.
service-id—
The service ID of the wholesaler. When specified in this context, SAP, SDP, interface, IP address and MAC parameters are ignored. This parameter only applies to the 7750 SR.
Values—
service-id: 1 to 2147483647

 

session—
Shows DHCPv6 lease states for clients that are associated with an IPoE session or for clients that are associated with a PPP session or for clients that are not associated with an IPoE session.
Values—
none, ipoe, ppp

 

policy-name—
Specifies the name of the router advertisement policy.
interface-name—
Specifies the interface name, up to 32 characters.
ipv6-address[/mask]—
Shows information for the specified IPv6 address and mask.
ieee-address—
Shows information for the specified 48-bit MAC address, expressed in the form aa:bb:cc:dd:ee:ff or aa-bb-cc-dd-ee-ff, where aa, bb, cc, dd, ee and ff are hexadecimal numbers.
Output 

The following output is an example of DHCP6 lease state information.

Sample Output
*A:eng-BNG-2# show  service id 1000 dhcp6 lease-state detail
===============================================================================
DHCP lease states for service 1000
===============================================================================
Service ID           : 1000
IP Address           : 2001:1000:0:4::1/128
Client HW Address    : 00:00:10:10:12:12
Subscriber-interface : sub-int-01
Group-interface      : grp-int-01
SAP                  : 1/1/20:841
Termination Type     : local
Up Time              : 0d 00:00:13
Remaining Lease Time : 0d 23:59:47
Remaining SessionTime: N/A
Persistence Key      : N/A
Sub-Ident            : "host-1"
Sub-Profile-String   : "no-prof"
SLA-Profile-String   : "no-prof"
App-Profile-String   : ""
Lease ANCP-String    : ""
Lease Int Dest Id    : ""
Category-Map-Name    : ""
Dhcp6 ClientId (DUID): 00030001000010101212
Dhcp6 IAID           : 0
Dhcp6 IAID Type      : non-temporary
Dhcp6 Client Ip      : fe80:db8:200:10ff:fe10:1212
Primary-Dns          : N/A
Secondary-Dns        : N/A
Pool Name            : ""
Dhcp6 Server Addr    : ::10
Dhcp6 ServerId (DUID): 00030001d854ff000000
Dhcp6 InterfaceId    : test
Dhcp6 RemoteId       : N/A
Radius sub-if prefix : N/A
Router adv. policy   : ra-policy-01
Lease Info origin    : DHCP
ServerLeaseStart     : 02/13/2017 22:04:24
ServerLastRenew      : 02/13/2017 22:04:24
ServerLeaseEnd       : 02/14/2017 22:04:24
Session-Timeout      : N/A
IPoE|PPP session     : No
Radius User-Name     : "00:00:10:10:12:12"
-------------------------------------------------------------------------------
Number of lease states : 1
===============================================================================
*A:Dut-A#show service id 13 dhcp6 lease-state router-advertisement-policy ra-policy-01
===============================================================================
DHCP lease state table, service 13
===============================================================================
IP Address      Mac Address       Sap/Sdp Id          Remaining  Lease    MC
                                                     LeaseTime  Origin   Stdby
-------------------------------------------------------------------------------
2013:bad:beaf::1/128
                00:00:00:00:00:13 1/1/1:13            23h47m34s  DHCP      
2013:bad:beaf::2/128
                00:00:00:00:00:14 1/1/1:13            23h52m36s  DHCP      
2013:bad:beaf::3/128
                00:00:00:00:00:15 1/1/1:13            23h54m17s  DHCP      
-------------------------------------------------------------------------------
Number of lease states : 3
===============================================================================
*A:Dut-A# 

Table 65 describes DHCP6 lease state router advertisement policy output fields.

Table 65:  DHCP6 Lease State Router Advertisement Policy Field Descriptions  

Field

Description

Service ID

The service ID provided by the access node to which this subnet is bound

IP Address

The IP address of the service

Client HW Address

The MAC address of the client

Subscriber-Interface

The subscriber interface for the service

Group-interface

The group interface for the service

Sap/Sdp ID

The service SAP and SDP IDs

Termination Type

The PPP session type

Up Time

The value of the up time at the time of the last modification of an entry

Remaining Lease Time

The time left for this lease

Remaining SessionTime

The time left for this session

Persistence Key

The persistence key

Sub-Ident

The subscriber identification policy name

Sub-Profile-String

The subscriber profile policy name

App-Profile-String

The application profile policy name

Lease ANCP-String

The ANCP string

Category-Map-Name

The category map name

Dhcp6 ClientID (DUID)

The DHCP client ID

Dhcp6 IAID

The DHCP6 Identity Association of the client

Dhcp6 IAID Type

The DHCP6 Identity Association of the client

Dhcp6 Client Ip

The DHCP6 IP address of the client

Primary-Dns

The primary DNS, if configured

Secondary-Dns

The secondary DNS, if configured

Pool Name

The pool name

Dhcp6 Server Addr

The DHCP6 server address

Dhcp6 ServerID (DUID)

The DHCP6 server ID

Dhcp6 InterfaceId

The DHCP6 interface ID

Dhcp6 RemoteId

The DHCP6 remote ID

Radius sub-if prefix

The RADIUS subscriber interface prefix

Router adv. policy

The router advertisement policy

Lease Info origin

The lease info origin

ServerLeaseStart

The date and time the lease was created

ServerLastRenew

The last renew was done for this lease

ServerLeaseEnd

The time left for this lease

Session-Timeout

The session timeout interval

IPoE|PPP

IPoE or PPP

Radius User-Name

The RADIUS user name

Number of lease states

The total number of lease states

virtual-subnet

Syntax 
virtual-subnet subscriber sub-ident
virtual-subnet [sap sap-id]
Context 
show>service>id
Description 

This command displays currently recorded default gateway and subnets for all virtual subnets enabled for DHCPv4 hosts in the specified service.

Parameters 
sub-ident—
Displays information relating to the specified subscriber ID
sap-id—
Displays information relating to the specified SAP ID
Output 

The following output is an example of virtual subnet information.

Sample Output
show service id 500 virtual-subnet 
===============================================================================
Virtual subnets in service 500
===============================================================================
Subscriber                  : 00:20:fc:1e:cd:52|1/1/9:200
-------------------------------------------------------------------------------
Default router              : 192.168.100.254
Subnet                      : 192.168.100.0/24
SAP                         : 1/1/9:200
-------------------------------------------------------------------------------
No. of subnets: 1
===============================================================================

Table 66 describes virtual subnet output fields.

Table 66:  Virtual Subnet Field Descriptions  

Field

Descriptions

Subscriber

The service identification that identifies the service in the service domain

Default router

The IP address of the default router received from either the DHCP or the RADIUS server

Subnet

The IP address of the subnet

SAP

The SAP associated with the service

No. of subnets

The total number of subnets for the service

ppp

Syntax 
ppp
Context 
show>service>id>ppp
Description 

This command enables the context to display service PPP information for the specified service.

session

Syntax 
session [user-name user-name] [sub-ppp-type {oa | oe | oeoa | ol2tp}] [interface ip-int-name | ip-address] [inter-dest-id intermediate-destination-id] [no-inter-dest-id] [ip-address ip-prefix[/prefix-length]] [port port-id] [sap sap-id] [termination-type ppp-session-type] [mlppp] [steering-profile steering-profile] [circuit-id circuit-id] [remote-id remote-id]
session [user-name user-name] [circuit-id circuit-id] [remote-id remote-id] detail
session [user-name user-name] [circuit-id circuit-id] [remote-id remote-id] statistics
Context 
show>service>id>ppp
Description 

This command displays PPP session information.

Parameters 
user-name—
Displays session information about the PPP user name.
sub-ppp-type—
Displays session information about the sub PPP type.
Values—
oa, oe, oeoa, ol2tp

 

ip-int-name—
Displays session information about the specified interface.
ip-address—
Displays session information about the IP address.
intermediate-destination-id—
Displays session information about the intermediate destination identifier, up to 32 characters, which is encoded in the identification strings.
no-inter-dest-id—
Displays session information about no intermediate destination ID.
ip-prefix/prefix-length—
Displays session information about the specified IP address and. mask
port-id—
Displays session information about the specified port.
sap-id—
Displays session information about the specified SAP.
ppp-session-type—
Displays session information about the specified PPP session type.
Values—
local, wholesale-local, retail-local, l2tp

 

mlppp—
Displays session information about MLPPP.
steering-profile—
Displays session information about the specified steering profile, up to 32 characters.
circuit-id—
Displays session information about the specified circuit ID, up to 256 characters.
remote-id—
Displays session information about the specified remote ID, up to 256 characters.
detail—
Displays detailed session information.
statistics—
Displays PPP session statistics.

statistics

Syntax 
statistics
statistics interface [ip-int-name | ip-address]
statistics sap sap-id
Context 
show>service>id>ppp
Description 

This command display PPP statistics information for the specified service ID.

Parameters 
ip-int-name—
Displays statistical information about the specified IP interface name
ip-address—
Displays statistical information about the specified IP address
sap-id—
Displays statistical information about the specified SAP

summary

Syntax 
summary
Context 
show>service>id>ppp
Description 

This command display summarized PPP information for the specified service ID.

3.6.2.1.10. Clear Commands

dhcp

Syntax 
dhcp
Context 
clear>router
Description 

This command enables the context to clear and reset DHCP entities.

local-dhcp-server

Syntax 
local-dhcp-server server-name
Context 
clear>router>dhcp
clear>router>dhcp6
Description 

This command clears DHCP server data.

Parameters 
server-name—
Clears data for the specified local DHCP server.

declined-addresses

Syntax 
declined-addresses ip-address[/mask]
declined-addresses pool pool-name
Context 
clear>router>dhcp>server
Description 

This command clears declined DHCP addresses.

Parameters 
pool-name—
Clears information about the declined pool name.
ip-address[/mask]—
Clears information about the declined IP address and mask.

failover-pool-stats

Syntax 
failover-pool-stats [pool-name]
Context 
clear>router>dhcp>server
clear>router>dhcp6>server
Description 

This command clears failover pool statistics.

Parameters 
pool-name—
Clears information about the pool name which is defined in the system.

leases

Syntax 
leases ip-address[/mask] [state]
leases all [state]
Context 
clear>router>dhcp>server
clear>router>dhcp6>server
Description 

This command clears DHCP leases.

Parameters 
ip-address[/mask]—
Clears the specified IP address and mask.
state—
Clears the state of the lease to be removed.
Values—
offered, stable, force-renew-pending, remove-pending, held, internal, internal-orphan, internal-held, sticky

 

pool-ext-stats

Syntax 
pool-ext-stats [pool-name]
Context 
clear>router>dhcp>server
clear>router>dhcp6>server
Description 

This command clears extended pool statistics.

Parameters 
pool-name—
Clears information about the pool name.

server-stats

Syntax 
server-stats
Context 
clear>router>dhcp>server
clear>router>dhcp6>server
Description 

This command clears all local DHCP or DHCPv6server statistics.

sticky-leases

Syntax 
sticky-leaseshostname [hostname]
sticky-leases hostname-prefix [hostname-prefix]
Context 
clear>router>dhcp>server
Description 

This command clears sticky leases.

Parameters 
hostname—
Clears information about the name of the host for which an entry is cleared.
hostname-prefix—
Clears information about the sub-string of all host names starting with that sub-string.

subnet-ext-stats

Syntax 
subnet-ext-stats ip-address[/mask]
subnet-ext-stats pool pool-name
Context 
clear>router>dhcp>server
Description 

This command clears extended subnet statistics.

Parameters 
ip-address[/mask]—
Clears the specified IP address and mask.
pool-name—
Clears statistics for the specified pool name.

statistics

Syntax 
statistics [ip-int-name | ip-address]
Context 
clear>router>dhcp
Description 

This command clears DHCP statistics.

Parameters 
ip-int-name—
Clears DHCP statistics for the specified interface name.
ip-address—
Clears DHCP statistics for the specified IP address.

dhcp6

Syntax 
dhcp6
Context 
clear>router
Description 

This command enables the context to clear and reset DHCP6 entities.

leases

Syntax 
leases [ipv6-address/prefix-length] [type] [state]
leases all [type] [state]
Context 
clear>router>dhcp6>server
Description 

This command removes the specified leases in the specified local DHCPv6 server.

Parameters 
ipv6-address/prefix-length—
Specifies the prefix of the leases to be removed.
type—
Specifies the type of the lease to be removed.
Values—
pd, slaac, wan-host

 

state—
Specifies the state of the lease to be removed.
Values—
advertised, remove-pending, held, internal, internal-orphan, internal-offered

 

all—
Removes all leases of specified type or state.

pool-threshold-stats

Syntax 
pool-threshold-stats [pool-name]
Context 
clear>router>dhcp6>server
Description 

This commands resets the peak stats in the pool level threshold stats in the specified pool. If the pool name is not specified, then the peak stats in all pools in the server will be reset.

Parameters 
pool-name—
Clears information about the specified local DHCPv6 server pool.

prefix-ext-stats

Syntax 
prefix-ext-stats ipv6-address/prefix-length
prefix-ext-stats pool pool-name
Context 
clear>router>dhcp6>server
Description 

This command reset the begin time of peak values in output of the show router rt-id dhcp6 local-dhcp-server svr-name prefix-ext-stats command/

Parameters 
ipv6-address/prefix-length—
Clears information about the specified IPv6 prefix.
pool-name—
Clears information about the specified local DHCPv6 server pool name.

prefix-threshold-stats

Syntax 
prefix-threshold-stats ipv6-address/prefix-length
prefix-threshold-stats pool pool-name
Context 
clear>router>dhcp6>server
Description 

This commands resets the peak stats in the prefix level threshold stats in the specified provision prefix or pool.

Parameters 
pool-name —
Clears information about the specified pool in local DHCPv6 server.
ipv6-address/prefix-length—
Clears information about the specified IPv6 prefix with prefix length.

statistics

Syntax 
statistics
Context 
clear>router>dhcp6
Description 

This command clears DHCP6 statistics.

statistics

Syntax 
statistics [interface ip-int-name | ipv6-address]
Context 
clear>service>id>dhcp6
Description 

This command clears DHCP statistics.

Parameters 
ip-int-name—
Clears DHCP statistics for the specified interface name.
ip-address—
Clears DHCP statistics for the specified IP address.

lease-state

Syntax 
lease-state all [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[/mask] [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]
Context 
clear>service>id>dhcp
Description 

This command clears DHCP lease state information.

Parameters 
all—
Clears all lease state statistics.
port-id—
Clears information about the specified port ID.
no-dhcp-release—
Specifies that the node will clear the state without sending the DHCP release message
intermediate-destination-id—
Specifies the intermediate destination identifier, up to 32 characters, which is encoded in the identification strings.
ip-address[/mask]—
Clears information about the specified IP address and mask. The ip-address portion of the address command specifies the IP host address that will be used by the IP interface within the subnet. This address must be unique within the subnet and specified in dotted decimal notation. Allowed values are IP addresses in the range 1.0.0.0 – 223.255.255.255 (with support of /31 subnets).
Values—
a.b.c.d.
mask: 1 to 32

 

ieee-address —
Clears the 48-bit MAC address for the static ARP in the form aa:bb:cc:dd:ee:ff or aa-bb-cc-dd-ee-ff where aa, bb, cc, dd, ee, and ff are hexadecimal numbers. Allowed values are any non-broadcast, non-multicast MAC and non-IEEE reserved MAC addresses.
Values—
xx:xx:xx:xx:xx:xx or xx-xx-xx-xx-xx-xx

 

sap-id—
Clears the specified lease state SAP information.
sdp-id—
Clears information about the specified SDP ID.
Values—
1 to 17407

 

vc-id—
Clears information about the specified virtual circuit ID on the SDP ID.
Values—
1 to 4294967295

 

lease-state

Syntax 
lease-state all [no-dhcp-release]
lease-state ipv6-address ipv6-prefix[/prefix-length] [no-dhcp-release]
lease-state mac ieee-address [no-dhcp-release]
lease-state sap sap-id [no-dhcp-release]
Context 
clear>service>id>dhcp6
Description 

This command clears DHCP6 lease state information.

Parameters 
all—
Clears all lease-states.
no-dhcp-release—
Specifies that the node clears the state without sending theDHCP release message.
ipv6-prefix[/prefix-length]—
Clears routes only matching the specified IP address and length and only applies to the 7750 SR.
Values—

ipv6

ipv6-prefix[/pref*:

x:x:x:x:x:x:x:x (eight 16-bit pieces)

x:x:x:x:x:x:d.d.d.d

x: [0 to FFFF]H

d: [0 to 255]D

prefix-length:

1 to 128

 

ieee-address—
Clears DHCP6 MAC address lease state information. The 48-bit MAC address for the static ARP in the form aa:bb:cc:dd:ee:ff or aa-bb-cc-dd-ee-ff where aa, bb, cc, dd, ee, and ff are hexadecimal numbers. Allowed values are any non-broadcast, non-multicast MAC and non-IEEE reserved MAC addresses.
sap-id—
Clears the specified lease state SAP information.

statistics

Syntax 
statistics [sap sap-id | sdp [sdp-id[:vc-id] | interface [ip-address | ip-int-name]]
Context 
clear>service>id>dhcp
Description 

This command clears DHCP statistics for this service.

Parameters 
sap-id—
Clears the specified SAP statistics.
sdp-id—
Specifies the SDP ID to be cleared.
Values—
1 to 17407

 

vc-id—
Specifies the virtual circuit ID on the SDP ID to be cleared.
Values—
1 to 4294967295

 

ip-int-name—
Clears the statistics for the IP interface with the specified name.
ip-addr—
Clears the statistics for the IP interface with the specified IP address.

3.6.2.1.11. Debug Commands

dhcp

Syntax 
[no] dhcp [interface ip-int-name]
[no] dhcp mac ieee-address
[no] dhcp sap sap-id
Context 
debug>router>ip
Description 

This command enables DHCP debugging.

The no form of this command disables debugging.

Parameters 
ip-int-name—
Specifies the name of the IP interface, up to 32 characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.
ieee-address—
Specifies the 48-bit MAC address for the static ARP in the form aa:bb:cc:dd:ee:ff or aa-bb-cc-dd-ee-ff where aa, bb, cc, dd, ee, and ff are hexadecimal numbers. Allowed values are any non-broadcast, non-multicast MAC and non-IEEE reserved MAC addresses.
sap-id—
Specifies the physical port identifier portion of the SAP definition.

detail-level

Syntax 
detail-level {low | medium | high}
no detail-level
Context 
debug>router>ip>dhcp
debug>router>ip>dhcp6
debug>router>local-dhcp-server
Description 

This command debugs the DHCP tracing detail level.

Parameters 
low—
Displays a low detail level for DHCP debugging.
medium—
Displays a medium detail level for DHCP debugging.
high—
Displays a high detail level for DHCP debugging.

mode

Syntax 
mode {dropped-only | ingr-and-dropped | egr-ingr-and-dropped}
no mode
Context 
debug>router>ip>dhcp
debug>router>ip>dhcp6
debug>router>local-dhcp-server
Description 

This command debugs the DHCP tracing detail level.

Parameters 
dropped-only—
Displays only dropped packets.
ingr-and-dropped—
Displays only ingress packet and dropped packets.
egr-ingr-and-dropped—
Displays ingress, egress and dropped packets.

dhcp6

Syntax 
dhcp6 [ip-int-name]
no dhcp6
Context 
debug>router>ip
Description 

This command enables DHCP debugging

The no form of this command disables debugging.

Parameters 
ip-int-name—
Specifies the name of the IP interface, up to 32 characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

local-dhcp-server

Syntax 
[no] local-dhcp-server server-name [lease-address ip-prefix[/prefix-length]]
[no] local-dhcp-server server-name [mac ieee-address]
[no] local-dhcp-server server-name [link-local-address ipv6z-address]
Context 
debug>router
Description 

This command enables, disables or configures debugging for a local DHCP server.

Parameters 
server-name—
Specifies an existing local DHCP server name.
ip-prefix[/prefix-length]—
Specifies the IP prefix and prefix length of the subnet.
Values—
ip-prefix — a.b.c.d (host bits must be 0)
length — 0 to 32

 

ieee-address—
Specifies that the provisioned MAC address for the local DHCP server.
ipv6z-address—
Specifies the IPv6z address.

ipv6-address:

x:x:x:x:x:x:x:x [-interface]

x:x:x:x:x:x:d.d.d.d [-interface]

x: [0 to FFFF]H

d: [0 to 255]D

interface

up to 32 characters, mandatory for link local addresses

3.6.2.1.12. Tools Commands

tools

Syntax 
tools
Context 
<root>
Description 

This command enables the context to enable useful tools for debugging purposes.

Parameters 
dump—
Enables dump tools for the various protocols.
perform—
Enables tools to perform specific tasks.

perform

Syntax 
perform
Context 
tools
Description 

This command enables the context to enable tools to perform specific tasks.

subscriber-mgmt

Syntax 
subscriber-mgmt
Context 
tools
tools>perform
Description 

This command enables tools to control subscriber management.

local-user-db

Syntax 
local-user-db local-user-db-name
Context 
tools>perform>subscr-mgmt
tools>perform>router>dhcp
tools>perform>router>dhcp6
Description 

This command enables tools for controlling the local user database.

Parameters 
local-user-db-name —
Specifies the name of a local user database

ipoe

Syntax 
ipoe
Context 
tools>perform>subscr-mgmt>loc-user-db
Description 

This command contains the tools used to control IPoE entries in the local user database.

host-lookup

Syntax 
host-lookup [mac ieee-address] [remote-id remote-id-ascii] [sap-id sap-id] [service-id service-id] [string vso-string] [system-id system-id] [option60 option-60-ascii] [circuit-id circuit-id-ascii] [circuit-id-hex circuit-id-hex] [option60-hex option60-hex] [remote-id-hex remote-id-hex] [derived-id derived-id] [ip-prefix ip-prefix/ip-prefix-length]
Context 
tools>perform>subscr-mgmt>loc-user-db>ipoe
Description 

This command performs a lookup in the local user database. This command looks up the host with the match-list configured in the local user database.

Parameters 
ieee-address —
Specifies the 48-bit MAC address for the static ARP in the form aa:bb:cc:dd:ee:ff or aa-bb-cc-dd-ee-ff where aa, bb, cc, dd, ee, and ff are hexadecimal numbers. Allowed values are any non-broadcast, non-multicast MAC and non-IEEE reserved MAC addresses.
remote-id—
Specifies the information which goes into the remote-id sub-option in the DHCP relay packet, up to 255 characters.
sap-id—
Specifies a SAP identifier to be used.
service-id—
Specifies an existing subscriber service ID.
Values—
1 to 2147483647

 

vso-string—
Specifies a Vendor Specific Option (VSO) string.
system-id—
Specifies the system ID.
Values—
up to 255 characters maximum

 

hex-string—
Specifies the content of option 60 for this lookup.
Values—
0x0 to 0xFFFFFFFF (maximum 64 hex nibbles)

 

circuit-id—
Specifies the circuit ID from the Option 82.
circuit-id-hex—
Specifies the circuit ID in hexadecimal format from the Option 82.
Values—
0x0 to 0xFFFFFFFF (maximum 254 hex nibbles)

 

sap-id—
Specifies a SAP ID, up to 255 characters maximum.
option-60-ascii—
Specifies the Vendor-Identifying Vendor Option to match against. Option 60 is encoded as Type - Length - Value and must be formatted in ASCII.
option-60-hex—
Specifies the Vendor-Identifying Vendor Option to match against. Option 60 is encoded as Type - Length - Value and must be formatted in HEX.

ppp

Syntax 
ppp
Context 
tools>perform>subscr-mgmt>loc-user-db
Description 

This command contains the tools used to control PPP entries in the local user database.

authentication

Syntax 
authentication user-name user-name password password] [circuit-id circuit-id] [circuit-id-hex circuit-id-hex] [mac ieee-address] [remote-id remote-id] [derived-id derived-id] [mac ieee-address] [remote-id-hex remote-id-hex] [sap-id sap-id] [service-name service-name]
Context 
tools>perform>subscr-mgmt>loc-user-db>ppp
Description 

This command authenticates PPP user name. As local user database PAP/CHAP authentication can only be used when the local user database is connected to the PPP node under the group interface, the user lookup will be performed with match-list username.

Parameters 
password—
Specifies the password of this host, up to 32 characters.
ieee-address—
Specifies information about the MAC address of the PPP session.
remote-id—
Specifies that information that goes into the remote-id sub-option in the DHCP relay packet, up to 255 characters.
circuit-id—
Specifies the circuit ID from the Option 82
circuit-id-hex—
Specifies the circuit ID in hexadecimal format from the Option 82.
Values—
0x0 to 0xFFFFFFFF (maximum 254 hex nibbles)

 

user-name—
Specifies the PPP user name.
service-name—
Specifies the service name.

host-lookup

Syntax 
host-lookup [circuit-id circuit-id] [circuit-id-hex circuit-id-hex] [derived-id derived-id] [mac ieee-address] [remote-id remote-id] [remote-id-hex remote-id-hex] [sap-id sap-id] [service-name service-name] [user-name user-name]
Context 
tools>perform>subscr-mgmt>loc-user-db>ppp
Description 

This command performs a lookup in the local user database.

Parameters 
ieee-address —
Specifies the 48-bit MAC address for the static ARP in the form aa:bb:cc:dd:ee:ff or aa-bb-cc-dd-ee-ff where aa, bb, cc, dd, ee, and ff are hexadecimal numbers. Allowed values are any non-broadcast, non-multicast MAC and non-IEEE reserved MAC addresses.
remote-id—
Specifies the information that goes into the remote-id sub-option in the DHCP relay packet, up to 255 characters.
user-name—
Specifies a user name, up to 128 characters.
service-name—
Specifies a PPP service name, up to 255 characters .
circuit-id circuit-id—
Specifies the circuit ID from the Option 82.
circuit-id-hex—
Specifies the circuit ID in hexadecimal format from the Option 82.
Values—
0x0 to 0xFFFFFFFF (maximum 254 hex nibbles)

 

derived-id derived-id—
Specifies an ASCII string that uniquely identifies a host and is derived by a Python script from packet content available during a DHCP transaction.

dhcp

Syntax 
dhcp
Context 
tools>perform>router
Description 

This command enables the context to configure tools DHCP parameters.

dhcp6

Syntax 
dhcp6
Context 
tools>perform>router
Description 

This command enables the context to configure tools DHCP6 parameters.

failover

Syntax 
failover
Context 
tools>perform>router>dhcp>server
tools>perform>router>dhcp>server>pool
tools>perform>router>dhcp6>server
tools>perform>router>dhcp6>server>pool
Description 

This command enables the context to perform local DHCP or DHCP6 server failover tasks.

abort-startup-wait

Syntax 
abort-startup-wait
Context 
tools>perform>router>dhcp>server>failover
tools>perform>router>dhcp>server>pool
tools>perform>router>dhcp6>server
tools>perform>router>dhcp6>server>pool
Description 

This command aborts the running start-up-wait time, forcing the DCHP server to transition immediately to the COMMUNICATIONS-INTERRUPTED state.

The start-up-wait time is started after a boot to enable two redundant routers to synchronize the DHCP server lease database before transitioning to the (PRE-)NORMAL state when the last state record from the peer is synchronized. If the last state record is not received before the start-up-wait time expires, it is assumed that the remote DHCP server is not operational and the DHCP server goes in COMMUNICATIONS-INTERRUPTED state.

force-partner-down

Syntax 
force-partner-down
Context 
tools>perform>router>dhcp>server>failover
tools>perform>router>dhcp>server>pool
tools>perform>router>dhcp6>server
tools>perform>router>dhcp6>server>pool
Description 

This command forces a DHCP server to transition from the COMMINICATIONS-INTERRUPTED state to the PARTNER-DOWN state.

It is important to note that this command should only be used if the remote DHCP server is out of service, else duplicate address allocations could occur.

In case of a communication failure between two redundant DHCP servers, the DHCP server transitions to the COMMUNICATIONS-INTERRUPTED state. In this state, the DHCP server allocates IP addresses for new leases from the local and address-driven address-ranges only. This prevents duplicate address allocations.

If during the partner-down-delay time, the communication with the remote DHCP server is not restored, then the DHCP server transitions to the PARTNER-DOWN state. In this state, the DHCP server also allocates IP addresses for new leases from the remote ranges. A DHCP server should only reach this state when the remote DHCP server is out of service, else IP address conflicts can occur.

pool

Syntax 
pool pool-name
Context 
tools>perform>router>dhcp>server
tools>perform>router>dhcp6>server
Description 

This command performs local DHCP or DHCP6 server IP address pool tasks.

Parameters 
pool-name—
Specifies the pool name.

create-sticky-lease

Syntax 
create-sticky-lease host-name [mac ieee-address] [circuit-id circuit-id] [client-id client-id] [requested-ip-address ip-address] [circuit-id-hex circuit-id-hex-string] [client-id-hex client-id-hex-string]
Context 
tools>perform>router>dhcp>server>pool
Description 

This command tries to create a lease-state in the specified local-dhcp-server pool with the supplied parameters. The hostname will uniquely identify this lease for subsequent operations. mac/circuit-id and client-id should also have a unique combination of values according to the configured user-ident variables.If the requested-ip-address is provided the server will try to create a lease with this address. If this address is not available in the pool, the command will fail.

Parameters 
host-name—
Specifies a string to identify the lease, up to 32 characters. If not specified, it can be internally generated based on MAC@ or another key.
ieee-address—
Specifies the MAC address in xx:xx:xx:xx:xx:xx or xx-xx-xx-xx-xx-xx format.
circuit-id—
Specifies the circuit-id string, up to 255 characters.
client-id—
Specifies the client-id string, up to 255 characters.
ip-address—
Specifies the IPv4 address in dotted notation a.b.c.d.

send-force-renew

Syntax 
send-force-renew ip-address
Context 
tools>perform>router>dhcp>server
Description 

This command sends a DHCP FORCERENEW message on behalf of the DHCP server to the DHCP client with specified IP address. A DHCP lease with the specified IP address must exist in the DHCP server.

Parameters 
ip-address—
Specifies the DHCP client’s IP address in dotted notation a.b.c.d.

dhcp-rx-stats

Syntax 
dhcp-rx-stats [clear]
Context 
tools>dump
Description 

This command displays the DHCP received packet statistics.

Parameters 
clear—
Clears DHCP RX statistics.
Output 

The following output is an example of DHCP RX statistics information.

Sample Output
*A:# tools dump dhcp-rx-stats 
===============================================================================
DHCP Received Packet Statistics
===============================================================================
     Type                  Received     Forwarded       Dropped  Dropped(ESM)
-------------------------------------------------------------------------------
IPv4 DISCOVER                    72            72             0             0
     OFFER                        2             2             0             0
     REQUEST                      4             4             0             0
     DECLINE                      0             0             0             0
     ACK                          1             1             0             0
     NAK                          0             0             0             0
     RELEASE                      0             0             0             0
     INFORM                       0             0             0             0
     FORCERENEW                   0             0             0             0
     LEASEQUERY                   0             0             0             0
     LEASEUNASSIGNED              0             0             0             0
     LEASEUNKNOWN                 0             0             0             0
     LEASEACTIVE                  0             0             0             0
     RENEW                        2             2             0             0
-------------------------------------------------------------------------------
IPv6 SOLICIT                      0             0             0             0
     ADVERTISE                    0             0             0             0
     REQUEST                      0             0             0             0
     CONFIRM                      0             0             0             0
     RENEW                        0             0             0             0
     REBIND                       0             0             0             0
     REPLY                        0             0             0             0
     RELEASE                      0             0             0             0
     DECLINE                      0             0             0             0
     RECONFIGURE                  0             0             0             0
     INFO_REQUEST                 0             0             0             0
     RELAY_FORW                   0             0             0             0
     RELAY_REPLY                  0             0             0             0
     LEASEQUERY                   0             0             0             0
     LEASEQUERY_REPLY             0             0             0             0
-------------------------------------------------------------------------------
     Total                       81            81             0             0
-------------------------------------------------------------------------------
Maximum queue length          : 0
Maximum outst pbufs total     : 1
Maximum outst pbufs to client : 1     
===============================================================================