ltm profile dhcpv6
ltm profile dhcpv6(1) BIG-IP TMSH Manual ltm profile dhcpv6(1)
NAME
DHCPv6 - Configures a Dynamic Host Configuration Protocol for IPv6 (DHCPv6) profile.
MODULE
ltm profile
SYNTAX
Configure the dhcpv6 profile within the ltm profile module using the syntax shown in the following sections.
CREATE/MODIFY
create dhcpv6 [name]
modify dhcpv6 [name]
options:
app-service [[string] | none]
defaults-from [[name] | none]
mode [relay | forwarding]
description [string]
idle-timeout [ [integer] | indefinite ]
default-lease-time [integer]
lease-query-max-retry [integer]
lease-query-only [true | false]
transaction-timeout [integer]
authentication {
options:
enabled [true | false]
virtual [[string] | none]
user-name {
options:
format [mac-address | option37 | mac-and-option37 | option38 | mac-and-option38 | option37-and-option38 | mac-and-option37-and-option38 | tcl-snippet]
separator1 [[string] | none]
separator2 [[string] | none]
tcl [[string] | none]
}
}
subscriber-discovery {
options:
enabled [true | false]
subscriber-id {
options:
format [mac-address | option37 | mac-and-option37 | option38 | mac-and-option38 | option37-and-option38 | mac-and-option37-and-option38 | tcl-snippet]
separator1 [[string] | none]
separator2 [[string] | none]
tcl [[string] | none]
}
}
remote-id-option {
add [true | false]
remove [true | false]
enterprise-number [integer]
value [string | none]
}
subscriber-id-option {
add [true | false]
remove [true | false]
value [string | none]
}
edit dhcpv6 [ [name] ... ]
options:
all-properties
non-default-properties
reset-stats dhcpv6
reset-stats dhcpv6 [ [ [name] | [regex] ] ... ]
DISPLAY
list dhcpv6
list dhcpv6 [ [ [name] | [regex] ] ... ]
show running-config dhcpv6
show running-config dhcpv6
[ [ [name] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition
show dhcpv6
show dhcpv6 [ [ [name] | [regex] ] ... ]
options:
(default | exa | gig | kil | meg | peta | raw | tera | yotta | zetta)
field-fmt
global
DELETE
delete dhcpv6 [name]
DESCRIPTION
You can use the dhcpv6 profile to manage DHCPv6 network traffic.
EXAMPLES
create dhcpv6 my_dhcpv6_profile defaults-from dhcpv6
Creates a custom DHCPv6 profile named my_dhcpv6_profile that inherits its settings from the system default
DHCPv6 profile.
list dhcpv6 all-properties
Displays all properties for all DHCPv6 profiles.
create dhcpv6 new_dhcpv6_profile {
mode relay
idle-timeout 120
transaction-timeout 45
default-lease-time 3600
subscriber-discovery {
enabled true
subscriber-id {
format mac-and-option37
separator1 @
}
}
authentication {
enabled true
virtual new_authen_vs
user-name {
format mac-and-option37
separator1 @
}
}
remote-id-option {
add false
remove true
}
subscriber-id-option {
add false
remove true
} }
Creates a DHCPv6 profile named new_dhcpv6_profile with idle-timeout value of <120 seconds>, transaction-time
out of <45 seconds> and default-lease-time of 3600 seconds. The BIG-IP virtual will work in relay mode, with
subscriber discovery enabled and configured with the subscriber-id format set to mac-and-option37 (remote-id
relay agent option) and to use the @ to concatenate both MAC address and option 37. The authentication is
enabled and its user-name equals the subscriber-id and the authentication virtual name is new_authen_vs. It
also does not add either option 37 or options 38 (remote-id option and subscriber-id option) but remove them
(if exists) from the server-to-client messages.
OPTIONS
app-service
Specifies the name of the application service to which the profile belongs. The default value is none.
Note: If the strict-updates option is enabled on the application service that owns the object, you cannot
modify or delete the profile. Only the application service can modify or delete the profile.
default-lease-time
Provides the default value in seconds of DHCPv6 lease time in case it was missing in the client-server
exchange. The default is 86400.
defaults-from
Specifies the profile that you want to use as the parent profile. Your new profile inherits all settings
and values from the parent profile. The default value is dhcpv6.
description
User defined description.
lease-query-max-retry
Specifies the maximum number of retries for a DHCPv6 lease query request.
lease-query-only
Specifies if a DHCPv6 virtual that uses this profile can be used for DHCP lease query only or for DHCP
discovery as well.
mode Specifies the operation mode of the DHCP virtual. If the virtual to run in relay mode, then it means that
it is acting as a standard DHCPv6 relay agent. This means that the relay will encapsulate the original
messages into one of the relay messages before it send it to the server or the client. In the forwarding mode,
the virtual will just forward the message to either the server or the client. The default is relay.
idle-timeout
Specifies the number of seconds that a connection is idle before the connection is eligible for deletion.
The default value is 60 seconds.
transaction-timeout
Specifies DHCPv6 transaction timeout, in seconds. The transactions should complete within the timeout
specified. If a transaction does not complete for any reason, it is removed. The default value is 45
seconds.
authentication
Manages the subscriber authentication attributes.
enabled
To enable or disable subscriber authentication. If enabled, then user has to fill the following
fields. Default is false.
virtual
Specifies the authentication virtual server name.
user-name
Manages the authentication user name's attributes. The user-name is what will be used to
authenticate the DHCP client.
format
Specifies the user-name format. The options are: MAC address, option37, MAC + option37,
option38, MAC + option38, option37 + option38, mac + option37 + option38 tcl-snippet. The
concatenation symbols are defined as separator1 and separator2.
separator1
A string that is used to concatenate the MAC address and the first two strings of the
authentication user-name. The default is @.
separator2
A string that is used to concatenate the MAC address and the second two strings of the
authentication user-name. The default is @.
tcl-snippet
A tcl snippet to format the user name. This value will be taken into account only if the format
value was chosen to be tcl-snippet.
subscriber-discovery
Manages the subscriber discovery attributes.
enabled
To enable or disable subscriber discovery. If enabled, then user has to fill the following fields.
Default is false.
subscriber-id
Manages the subscriber-id attributes. The subscriber-id is used by SPM to create, delete and update
subscriber sessions.
format
Specifies the user-name format. The options are: MAC address, option37, MAC + option37,
option38, MAC + option38, option37 + option38, mac + option37 + option38 tcl-snippet. The
concatenation symbols are defined as separator1 and separator2.
separator1
A string that is used to concatenate the first two strings of the subscriber-id. The default is
@.
separator2
A string that is used to concatenate the second two strings of the subscriber-id. The default
is @.
tcl-snippet
A tcl snippet to format the subscriber-id. This value will be taken into account only if the
format value was chosen to be tcl-snippet.
remote-id-option
Manages the DHCPv6 relay agent remote-id option (option 37) attributes. As a relay, the DHCP virtual can
insert or remove this option.
add Specifies if the user wants the DHCP relay agent to insert option 37 or not. Default is false.
remove
Specifies if the user wants the DHCP relay agent to remove option 37 from the server-to-client
traffic or not. Default is false.
enterprise-number
Specifies the enterprise number of the inserted remote-id option (option 37).
value
A string to represent the remote-id option value.
subscriber-id-option
Manages the DHCPv6 relay agent subscriber-id option (option 38) attributes. As a relay, the DHCP virtual
can insert or remove this option.
add Specifies if the user wants the DHCP relay agent to insert option 38 or not. Default is false.
remove
Specifies if the user wants the DHCP relay agent to remove option 38 from the server-to-client
traffic or not. Default is false.
value
A string to represent the subscriber-id option value.
SEE ALSO
create, delete, edit, ltm profile, ltm virtual, modify, show, dhcpv6 profile, reset-stats, tmsh
COPYRIGHT
No part of this program may be reproduced or transmitted in any form or by any means, electronic or
mechanical, including photocopying, recording, or information storage and retrieval systems, for any purpose
other than the purchaser's personal use, without the express written permission of F5 Networks, Inc.
F5 Networks and BIG-IP (c) Copyright 2008-2010, 2012-2015. All rights reserved.
BIG-IP 2017-07-21 ltm profile dhcpv6(1)