Configuring DHCPv6 in Gaia Clish

Important:

  • Scalable Platforms (ElasticXL, Maestro, and Chassis) do not support this feature (Known Limitation MBS-3246).

  • On a VSX Gateway / each VSX Cluster Member, you must run these commands in the context of the applicable Virtual System (set virtual-system <VS ID>).

Workflow

  1. Add the required IPv6 subnets and allocated IPv6 pools:

    add dhcp6 server subnet <Subnet IPv6 Address> prefix <Subnet Mask Length> [exclude-ip-pool ...] [include-ip-pool ...]

  2. Enable the configured subnets:

    set dhcp6 server subnet <Subnet IPv6 Address> enable

  3. Enable the DHCPv6 Server:

    set dhcp6 server enable

Gaia OS can work in these DHCPv6 Client modes (these modes are mutually exclusive):

  • Regular DHCPv6 Client mode (default).

    1. Configure the DHCPv6 Client mode:

      set dhcp6 client client-mode normal

    2. Configure the DHCPv6 Client settings:

      set dhcp6 client

            hostname ...

            interface ...

  • Advanced DHCPv6 prefix-delegation mode (a mix of the DHCPv6 Client and the DHCPv6 Server).

    1. Configure the DHCPv6 Client mode:

      set dhcp6 client client-mode prefix-delegation

    2. Configure the DHCPv6 Prefix Delegation settings:

      set dhcp6 prefix-delegation ...

This part applies only if you configured the DHCPv6 Client mode "prefix-delegation".

  1. Configure the Prefix Delegation method:

    set dhcp6 prefix-delegation delegation-method ...

  2. Configure the interface that will send DHCPv6 requests to the DHCPv6 server:

    set dhcp6 prefix-delegation request-from ...

  3. Configure which interfaces should be configured with an IPv6 address in the relevant subnet and subsequently start assigning IPv6 addresses to hosts on that subnet:

    add dhcp6 prefix-delegation assign-to...

  4. Configure the IPv6 addresses for the allocated IP Pools (if you configured the delegation method "dhcpv6"):

    add dhcp6 prefix-delegation suffix-pools ...

  1. Save the changes in the Gaia database:

    save config

  2. Examine the DHCPv6 settings:

    show dhcp6 ...

Syntax

add dhcp6

      prefix-delegation

            assign-to <Name of Interface>

            suffix-pools

                  exclude-pool start <First IPv6 Address> end <Last IPv6 Address>

                  include-pool start <First IPv6 Address> end <Last IPv6 Address>

      server subnet <Subnet IPv6 Address>

            exclude-ip-pool start <First IPv6 Address> end <Last IPv6 Address>

            include-ip-pool start <First IPv6 Address> end <Last IPv6 Address>

            prefix <IPv6 Subnet Mask Length>

set dhcp6

      client

            client-mode {normal | prefix-delegation}

            hostname <IPv6 Hostname>

            interface <Logical Name of Interface>

                  leasetime <0-4294967295>

                  reboot <0-4294967295>

                  retry <0-4294967295>

                  timeout <0-4294967295>

      prefix-delegation

            delegation-method {manual | rdisc6 | dhcpv6}

            request-from <Name of Interface>

      server {enable | disable}

      server subnet <Subnet IPv6 Address>

            {disable | enable}

            default-lease <Lease in Seconds>

            max-lease <Maximum Lease in Seconds>

            dns "<DNS Server 1>, <DNS Server 2>, <DNS Server 3>"

            domain <Domain Name>

            exclude-ip-pool <First IPv6 Address-Last IPv6 Address> {disable | enable}

            include-ip-pool <First IPv6 Address-Last IPv6 Address> {disable | enable}

delete dhcp6

      client interface <Logical Name of Interface>

      prefix-delegation

            assign-to <Name of Interface>

            request-from <Name of Interface>

            suffix-pools exclude-pool <First IPv6 Address>

            suffix-pools include-pool <First IPv6 Address>

      server subnet <Subnet IPv6 Address>

            exclude-ip-pool <First IPv6 Address>

            include-ip-pool <First IPv6 Address>

show dhcp6

      client

            client-mode

            interface <Name of Interface>

            interfaces

      prefix-delegation

            all

            assign-to

            delegation-method

            request-from

            status

            suffix-pools

      server

            all

            status

            subnet <Subnet IPv6 Address> [ip-pools]

            subnets

Important - After you add, configure, or delete features, run the "save config" command to save the settings permanently. Scalable Platforms save the changes automatically.

Parameters

Parameter

Description

add dhcp6 prefix-delegation assign-to <Name of Interface>

Specifies the interface that should be configured with an IPv6 address in the relevant subnet and subsequently start assigning IPv6 addresses to hosts on that subnet.

Gaia OS automatically creates a /64 network ID and uses it generate an IPv6 address for the assigned interfaces.

add dhcp6 client interface <interface name

Configures the interface as DHCPv6 client (in client-mode ‘normal’).

add dhcp6 prefix-delegation suffix-pools exclude-pool start <First IPv6 Address> end <Last IPv6 Address>

Specifies the IPv6 address that starts and the IPv6 address that ends the excluded allocated IP Pool range.

Note - Applies only if you configured "set dhcp6 prefix-delegation delegation-method dhcpv6".

add dhcp6 prefix-delegation suffix-pools include-pool start <First IPv6 Address> end <Last IPv6 Address>

Specifies the IPv6 address that starts and the IPv6 address that ends the included allocated IP Pool range.

Note - Applies only if you configured "set dhcp6 prefix-delegation delegation-method dhcpv6".

add dhcp6 server subnet <Subnet IPv6 Address>

Specifies the IPv6 address of the DHCP subnet on an Ethernet interface of the Gaia device.

Hosts behind the Gaia interface get IPv6 addresses from address pools in the subnet.

add dhcp6 server subnet <Subnet IPv6 Address> exclude-pool start <First IPv6 Address> end <Last IPv6 Address>

For the specified subnet, configures the IPv6 address that starts and the IPv6 address that ends the excluded allocated IP Pool range.

add dhcp6 server subnet <Subnet IPv6 Address> include-pool start <First IPv6 Address> end <Last IPv6 Address>

For the specified subnet, configures the IPv6 address that starts and the IPv6 address that ends the included allocated IP Pool range.

add dhcp6 server subnet <Subnet IPv6 Address> prefix <Subnet Mask Length>

For the specified subnet, configures the IPv6 Subnet Mask Length from 8 to 128.

set dhcp6 server {enable | disable}

Enables and disables the DHCPv6 Server feature in Gaia OS.

set dhcp6 client client-mode {normal | prefix-delegation}

Specifies the working mode of the DHCPv6 Client (of the dhclient6 daemon):

  • normal

    Receives IPv6 and DNS servers from the configured DHCPv6 server.

    For additional settings, use the "set dhcp6 client" commands.

  • prefix-delegation

    Receives only the IPv6 prefix from the configured DHCPv6 server.

    Uses the assigned prefix in your network.

    For additional settings, use the "set dhcp6 prefix-delegation" commands and "add dhcp6 prefix-delegation suffix-pools" commands.

These DHCPv6 Client modes are mutually exclusive.

set dhcp6 client hostname <IPv6 Hostname>

Optional. Specifies the hostname for the DHCPv6 Client.

If you do not specify this hostname, the DHCPv6 server assigns a hostname to the client.

set dhcp6 client interface <Logical Name of Interface> leasetime <0-4294967295>

Lease duration time, in seconds, requested from the server.

set dhcp6 client interface <Logical Name of Interface> reboot <0-4294967295>

Default: 10

Thee time interval, in seconds, the client will wait before trying to discover a new IP address, after it has already tried to reacquire its current IP address.

set dhcp6 client interface <Logical Name of Interface> retry <0-4294967295>

Default: 300

The time, in seconds, to wait before retrying to contact a server.

set dhcp6 client interface <Logical Name of Interface> timeout <0-4294967295>

Default: 60

The time interval, in seconds, during which the client will try contacting a server.

set dhcp6 prefix-delegation delegation-method {manual | rdisc6 | dhcpv6}

Specifies how Gaia OS configures the system after receiving a prefix from the DHCPv6 server.

Each method is a trade-off between granularity and automation.

  • manual

    Only calculates IPv6 addresses from the prefix and assigns them to the interfaces configured to receive IPv6 through Prefix-Delegation.

  • rdisc6

    In addition to IPv6 addresses, configures the Router Discovery protocol on all configured interfaces.

    Does not enabled the "Managed Configuration" flag (ManagedFlag).

  • dhcpv6

    In addition to IPv6 addresses, configures the DHCPv6 Server feature on all assigned interfaces and configures the Router Discovery protocol with the enabled "Managed Configuration" flag (ManagedFlag).

    This method requires at least one IPv6 range.

set dhcp6 prefix-delegation request-from <Name of Interface>

Specifies the interface, on which to send prefix-delegation requests.

set dhcp6 server subnet <Subnet IPv6 Address>

Specifies the existing subnet, for which to configure the settings.

set dhcp6 server subnet <Subnet IPv6 Address> {disable | enable}

For the specified subnet, disables or enables the DHCPv6 Server.

set dhcp6 server subnet <Subnet IPv6 Address> default-lease <Lease in Seconds>

For the specified subnet, configures the default DHCPv6 lease time that should be granted to DHCPv6 clients.

Applies only if DHCPv6 clients do not request a unique lease time.

Range: 1 - 4294967295

Default: 43200

set dhcp6 server subnet <Subnet IPv6 Address> max-lease <Maximum Lease in Seconds>

For the specified subnet, configures the maximum DHCPv6 lease time that should be granted to DHCPv6 clients that do not request a specific lease.

Range: 1 - 4294967295

Default: 86400

set dhcp6 server subnet <Subnet IPv6 Address> dns "<DNS Server IPv6 Addresses>"

Optional. For the specified subnet, configures the IPv6 addresses of DNS servers that the network hosts will use to resolve hostnames.

Configure the DNS servers in the order of precedence.

For example: dns "2001:0ba0::1, 2001:0ba0::2, 2001:0ba0::3"

set dhcp6 server subnet <Subnet IPv6 Address> domain <Domain Name>

Optional. For the specified subnet, configures the domain name of the network hosts.

For example: example.com

Note - Domain names that are also valid numeric IPv6 addresses (for example 2001:0ba0::1) are not supported.

set dhcp6 server subnet <Subnet IPv6 Address> exclude-ip-pool <First IPv6 Address-Last IPv6 Address> {disable | enable}

Optional. For the specified subnet, disables or enables the excluded allocated IP Pool range.

set dhcp6 server subnet <Subnet IPv6 Address> include-ip-pool <First IPv6 Address-Last IPv6 Address> {disable | enable}

Optional. For the specified subnet, configures the included allocated IP Pool range.

delete dhcp6 client interface <Logical Name of Interface>

Deletes the DHCPv6 client configuration for the specified logical interface.

delete dhcp6 prefix-delegation assign-to <Name of Interface>

Deletes the interface that is configured to get an IPv6 address through prefix delegation.

delete dhcp6 prefix-delegation suffix-pools exclude-pool <First IPv6 Address>

Deletes the excluded allocated IP Pool range.

delete dhcp6 prefix-delegation suffix-pools include-pool <First IPv6 Address>

Deletes the included allocated IP Pool range.

delete dhcp6 server subnet <Subnet IPv6 Address> exclude-ip-pool <First IPv6 Address-Last IPv6 Address>

For the specified subnet, deletes the excluded allocated IP Pool range.

delete dhcp6 server subnet <Subnet IPv6 Address> include-ip-pool <First IPv6 Address-Last IPv6 Address>

For the specified subnet, deletes the included allocated IP Pool range.

show dhcp6 client client-mode

Shows the configured DHCPv6 Client mode.

show dhcp6 client interface <Name of Interface>

Shows the DHCPv6 settings for the specified interface.

show dhcp6 client interfaces

Shows the DHCPv6 settings for all interfaces.

show dhcp6 prefix-delegation

Shows the DHCPv6 prefix delegation settings:

  • all

    Shows the summary of the current DHCPv6 prefix-delegation settings.

  • assign-to

    Shows the interfaces that are configured through prefix delegation.

  • delegation-method

    Shows the configured delegation method.

  • request-from

    Shows the interface that sends prefix delegation requests.

  • status

    Shows the status of the prefix-delegation mode.

  • suffix-pools

    Shows the suffix IP Pools.

show dhcp6 server

Shows the DHCPv6 Server settings:

  • all

    Shows all DHCPv6 Server settings.

  • status

    Shows the DHCPv6 Server status (enabled / disabled).

  • subnet <Subnet IPv6 Address> [ip-pools]

    Shows the DHCPv6 settings for the specified subnet.

  • subnets

    Shows the DHCPv6 settings for all configured subnets.