ltm profile dhcpv4
ltm profile dhcpv4(1) BIG-IP TMSH Manual ltm profile dhcpv4(1)
NAME
DHCPv4 - Configures a Dynamic Host Configuration Protocol (DHCP) profile.
MODULE
ltm profile
SYNTAX
Configure the dhcpv4 profile within the ltm profile module using the syntax shown in the following sections.
CREATE/MODIFY
create dhcpv4 [name]
modify dhcpv4 [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 | mac-and-relay-option | relay-option | tcl-snippet]
suboption-id1 [integer]
suboption-id2 [integer]
separator1 [[string] | none]
separator2 [[string] | none]
tcl [[string] | none]
}
}
subscriber-discovery {
options:
enabled [true | false]
subscriber-id {
options:
format [mac-address | mac-and-relay-id | tcl-snippet]
suboption-id1 [integer]
suboption-id2 [integer]
separator1 [[string] | none]
separator2 [[string] | none]
tcl [[string] | none]
}
}
relay-agent-id {
options:
add [true | false]
remove [true | false]
suboption {
options:
id1 [integer]
id2 [integer]
value1 [string | none]
value2 [string | none]
}
}
ttl-value [integer]
ttl-dec-value [ by-0 | by-1 | by-2 | by-4 ]
max-hops [integer]
edit dhcpv4 [ [name] ... ]
options:
all-properties
non-default-properties
reset-stats dhcpv4
reset-stats dhcpv4 [ [ [name] | [regex] ] ... ]
DISPLAY
list dhcpv4
list dhcpv4 [ [ [name] | [regex] ] ... ]
show running-config dhcpv4
show running-config dhcpv4
[ [ [name] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition
show dhcpv4
show dhcpv4 [ [ [name] | [regex] ] ... ]
options:
(default | exa | gig | kil | meg | peta | raw | tera | yotta | zetta)
field-fmt
global
DELETE
delete dhcpv4 [name]
DESCRIPTION
You can use the dhcpv4 profile to manage DHCPv4 network traffic.
EXAMPLES
create dhcpv4 my_dhcpv4_profile defaults-from dhcpv4
Creates a custom DHCPv4 profile named my_dhcpv4_profile that inherits its settings from the system default DHCPv4 profile.
list dhcpv4 all-properties
Displays all properties for all DHCPv4 profiles.
create dhcpv4 new_dhcpv4_profile {
mode relay
idle-timeout 120
transaction-timeout 45
default-lease-time 3600
ttl-value 0
ttl-dec-value by-2
max-hops 4
subscriber-discovery {
enabled true
subscriber-id {
format mac-and-relay-option
suboption-id1 1
separator1 -
}
}
authentication {
enabled true
virtual new_authen_vs
user-name {
format mac-and-relay-option
suboption-id1 1
separator1 -
}
}
relay-agent-id {
add false
remove true
} }
Creates a DHCPv4 profile named new_dhcpv4_profile with idle-timeout value of <120 seconds>, transaction-timeout of <45
seconds>, default-lease-time of 3600 seconds, ttl-dec-value of 2 and max-hops of 4. The BIG-IP virtual will work in relay
mode, with subscriber discovery enabled and configured with the subscriber-id format set to mac-and-relay-option and
configured to use only suboption 1 (the first suboption ID) of the relay-agent info option (option 82) and to use the - to
concatenate the MAC address to the first suboption ID. 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 relay agent option 82 but removed
it (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 DHCPv4 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 dhcpv4.
description
User defined description.
lease-query-max-retry
Specifies the maximum number of retries for a DHCPv4 lease query request.
lease-query-only
Specifies if a DHCPv4 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 DHCPv4 relay agent. This means that the relay will change some of the DHCPv4 packet fields before
sending it to either the client or server. The forwarding mode is similar to relay except that the virtual will not
modify the standard fields, instead it will forward the message from client to server and vice-versa. 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 DHCPv4 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, MAC + relay-agent option, relay-agent option
or tcl-snippet. The concatenation symbol is defined as separator1.
suboption-id1
The relay-agent option (option 82) first suboption ID. The default is 1.
suboption-id2
The relay-agent option (option 82) second suboption ID. The default is 2.
separator1
A string that is used to concatenate the MAC address and the relay-agent info option (option 82) to create
the authentication user-name. The default is @.
separator2
A string that is used to concatenate the relay-agent info option (option 82) suboptions 1 and 2 to create
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 subscriber-id format. The options are: MAC address, MAC + relay-agent option, relay-agent
option or tcl-snippet. The concatenation symbol is defined as separator1.
suboption-id1
The relay-agent info option (option 82) first suboption ID. The default is 1.
suboption-id2
The relay-agent info option (option 82) second suboption ID. The default is 2.
separator1
A string that is used to concatenate the MAC address and the relay-agent info option (option 82) to create
the subscriber-id. The default is @.
separator2
A string that is used to concatenate the relay-agent info option (option 82) suboptions 1 and 2 to create
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.
relay-agent-id
Manages the relay agent information option (option 82) attributes. As a relay, the DHCP virtual can insert this
option.
add Specifies if the user wants the DHCP relay agent to insert option 82 or not. Default is false.
remove
Specifies if the user wants the DHCP relay agent to remove option 82 from the server-to-client traffic or not.
Default is false.
suboptions
Manages the inserted relay agent information option (option 82) suboptions. We allow only two suboptions to be
inserted.
id1 An integer to represent the first suboption ID. Default is 1.
value1
A string to represent the first suboption value.
id2 An integer to represent the second suboption ID. Default is 2.
value2
A string to represent the second suboption value.
ttl-value
Specifies the ttl absolute value that the user may want to set for each outgoing DHCP packet. Default is 0; and in
this case, we use the ttl-dec-value field.
ttl-dec-value
Specifies the amount that the DHCP virtual will use to decrement the ttl for each outgoing DHCP packet. Default is
by-1.
max-hops
Specifies the maximum number of relay agents that the DHCPv4 messages pass through before they are discarded. The
default is 4.
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-2014. All rights reserved.
BIG-IP 2017-07-21 ltm profile dhcpv4(1)