Router DHCP commands for 7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C

local-dhcp-server

Syntax

local-dhcp-server server-name [create]

no local-dhcp-server server-name

Context

config>router>dhcp

Platforms

7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C

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.

Parameters

server-name

Specifies the name of local DHCP server.

create

Specifies that the local DHCP server is created. The create keyword requirement can be enabled or disabled in the environment>create context.

force-renews

Syntax

[no] force-renews

Context

config>router>dhcp>server

Platforms

7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C

Description

This command enables the sending of force-renew messages.

The no form of this command disables the sending of force-renew messages.

Default

no force-renews

lease-hold-time

Syntax

lease-hold-time [lease-hold-time]

no lease-hold-time

Context

config>router>dhcp>server

Platforms

7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C

Description

This command configures the time to remember this lease. This lease-hold-time is for unsolicited release conditions such as lease timeout and normal solicited release from DHCP client.

The no form of this command reverts to the default.

Default

sec 0

Parameters

lease-hold-time

Specifies the amount of time to remember the lease.

Values

days days

0 to 3650

hrs hours

0 to 23

min minutes

0 to 59

sec seconds

0 to 59

pool

Syntax

pool pool-name [create]

no pool pool-name

Context

config>router>dhcp>server

Platforms

7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C

Description

This command configures a DHCP address pool on the router.

Parameters

pool name

Specifies the name of this IP address pool. Allowed values are any string up to 32 characters composed of printable, 7-bit ASCII characters.

create

Specifies that the pool is created. 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

Platforms

7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C

Description

This command configures the maximum lease time.

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

Default

10 days

Parameters

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

Platforms

7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C

Description

This command configures the minimum lease time.

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

Default

10 minutes

Parameters

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

Platforms

7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C

Description

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

The no form of this command reverts to the default.

Default

1

Parameters

minimum-free

Specifies the minimum number of free addresses.

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 or subnet of local DHCP server are depleted.

nak-non-matching-subnet

Syntax

[no] nak-non-matching-subnet

Context

config>router>dhcp>server>pool

Platforms

7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C

Description

This command configures the system to return a DHCP NAK message if the following conditions are met:

  • the local DHCPv4 server receives a DHCP request with option 50 (meaning the client is trying to request a previously allocated message as described in section 3.2 of RFC 2131, Dynamic Host Configuration Protocol)

  • the address allocation algorithm uses a pool and the address in option 50 is not in the pool

If the conditions are not met, the system drops the DHCP packet.

Default

no nak-non-matching-subnet

offer-time

Syntax

offer-time [min minutes] [sec seconds]

no offer-time

Context

config>router>dhcp>server>pool

Platforms

7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C

Description

This command configures the offer time.

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

Default

1 minute

Parameters

time

Specifies the offer time.

Values

min minutes

0 to 10

sec seconds

0 to 59

options

Syntax

options

Context

config>router>dhcp>server>pool

config>router>dhcp>server>pool>subnet

Platforms

7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C

Description

Commands in this context 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...(up to 4 max)]

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

Platforms

7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C

Description

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

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

Parameters

option-number

Specifies the option number that the DHCP server uses to send the identification strings to the DHCP client.

Values

1 to 254

address ip-address

Specifies the IP address of this host.

hex hex-string

Specifies the hex value of this option.

Values

0x0 to 0xFFFFFFFF (maximum 254 hex nibbles)

string ascii-string

Specifies the value of this option, up to 127 characters.

dns-server

Syntax

dns-server address [ip-address...(up to 4 max)]

no dns-server

Context

config>router>dhcp>server>pool>options

Platforms

7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C

Description

This command configures the IP address of the DNS server.

Parameters

ipv-address

Specifies the IP address of the DNS server in dotted-decimal notation. Up to four addresses can be entered.

Values

a.b.c.d

domain-name

Syntax

domain-name domain-name

no domain-name

Context

config>router>dhcp>server>pool>options

Platforms

7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C

Description

This command configures the default domain for a DHCP client that the router uses to complete unqualified hostnames (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.

Values

127 character maximum

lease-rebind-time

Syntax

lease-rebind-time [lease-rebind-time]

no lease-rebind-time

Context

config>router>dhcp>server>pool>options

Platforms

7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C

Description

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

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

Parameters

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 [lease-renew-time]

no lease-renew-time

Context

config>router>dhcp>server>pool>options

Platforms

7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C

Description

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

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

Parameters

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 [lease-time]

no lease-time

Context

config>router>dhcp>server>pool>options

Platforms

7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C

Description

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

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

Parameters

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

subnet

Syntax

subnet {ip-address/mask | ip-address netmask} [create]

no subnet {ip-address/mask | ip-address netmask}

Context

config>router>dhcp>server>pool

Platforms

7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C

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.

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.

Values

a.b.c.d (no multicast address)

mask

Specifies the subnet mask in Classless Inter-Domain Routing (CIDR) notation, expressed as a decimal integer.

Values

8 to 30

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.

Values

a.b.c.d (any mask expressed as dotted quad)

create

Specifies that the subnet is created. 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}]

Context

config>router>dhcp>server>pool>subnet

Platforms

7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C

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 are included (other than specific excluded addresses).

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.

Values

a.b.c.d

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.

Values

a.b.c.d

failover local

Specifies that the DHCP server failover control type is in control under normal operation.

failover remote

Specifies that the remote DHCP server failover system is in control under normal operation.

exclude-addresses

Syntax

[no] exclude-addresses start-ip-address [end-ip-address]

Context

config>router>dhcp>server>pool>subnet

Platforms

7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C

Description

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

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.

Values

a.b.c.d

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.

Values

a.b.c.d

maximum-declined

Syntax

maximum-declined maximum-declined

no maximum-declined

Context

config>router>dhcp>server>pool>subnet

Platforms

7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C

Description

This command configures the maximum number of declined addresses allowed.

Default

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

Platforms

7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C

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.

Default

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

This parameter enables a system-generate event when all available addresses in the pool or subnet of local DHCP server are depleted.

default-router

Syntax

default-router ip-address [ip-address...(up to 4 max)]

no default-router

Context

config>router>dhcp>server>pool>subnet>options

Platforms

7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C

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 or addresses from the configuration.

Parameters

ip-address

Specifies the IP address of the default router. This address must be unique within the subnet and specified in dotted decimal notation.

Values

a.b.c.d

subnet-mask

Syntax

subnet-mask ip-address

no subnet-mask

Context

config>router>dhcp>server>pool>subnet>options

Platforms

7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C

Description

This command specifies the subnet-mask option to the client. The mask can either be defined (for super-netting) 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.

Values

a.b.c.d

use-gi-address

Syntax

use-gi-address [scope scope]

Context

config>router>dhcp>local-dhcp-server

Platforms

7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C

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 subnet 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. Because 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.

Default

no use-gi-address

Parameters

scope scope

Specifies if addresses are assigned for a specific subnet where the GI address belongs to only or for all subnets part of the pool.

Values

subnet — Addresses are only assigned for the subnet where the GI address belongs.

pool — All subnets that are part of the pool containing the subnet to which the GI address can assign addresses.

user-db

Syntax

user-db local-user-db-name [create]

no user-db

Context

config>router>dhcp>server

Platforms

7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C

Description

This command configures a local user database for authentication.

Default

no user-db

Parameters

local-user-db-name

Specifies the name of a local user database.

create

Specifies that the local user database is created. The create keyword requirement can be enabled or disabled in the environment>create context.