APIRef_tm_ltm_profile_dhcpv4¶
mgmt/tm/ltm/profile/dhcpv4
Dynamic Host Configuration Protocol, DHCPv4, profile to manage DHCPv4 network traffic.
REST Endpoints
- Collection URI
/mgmt/tm/ltm/profile/dhcpv4- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/ltm/profile/dhcpv4/~resource id- Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST- Resource Natural Key
name, partition, subPath
Properties
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
appService |
string | optional | read/write | The application service to which the object belongs. | |
defaultLeaseTime |
integer | 86400 | optional | read/write | Provides the default value in seconds of DHCPv4 lease time in case it was missing in the client-server exchange. The default is 86400. |
defaultsFrom |
string | optional | read/write | Specifies the profile that you want to use as the parent profile. Your new profile inherits all settings and values from the parent profile | |
description |
string | optional | read/write | User defined description. | |
idleTimeout |
string | 60 | optional | read/write | Specifies the number of seconds that a connection is idle before the connection is eligible for deletion. The default value is 60 seconds. |
maxHops |
integer | 4 | optional | read/write | Specifies the maximum number of relay agents that the DHCPv4 messages pass through before they are discarded. The default is 4. |
mode |
string | relay | optional | read/write | Specifies the operation mode of the DHCP virtual. If the virtual to run in relay mode, then it is acting as a standard DHCPv4 relay agent. 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. |
tmPartition |
string | Common | optional | read/write | Displays the administrative partition within which this profile resides. |
transactionTimeout |
integer | 45 | optional | read/write | Specifies the DHCPv4 transaction timeout, in seconds. The transaction should complete within the timeout specified. If a transaction does not complete for any reason, it is removed. The default value is 45 seconds. |
ttlDecValue |
string | by-1 | optional | read/write | Specifies the amount that the DHCP virtual will use to decrement the ttl for each outgoing DHCP packet. Default is by-1. |
ttlValue |
integer | 0 | optional | read/write | 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. |
Structures
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
/authentication |
array_structure | optional | read/write | ||
/authentication/enabled |
string | false | optional | read/write | To enable or disable subscriber authentication. If enabled, then user has to fill the following fields. Default is false. |
/authentication/virtual |
string | optional | read/write | Specifies the authentication virtual server name. | |
/authentication/user-name |
array_structure | optional | read/write | ||
/authentication/user-name/format |
string | mac-address | optional | read/write | 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. |
/authentication/user-name/separator1 |
string | @ | optional | read/write | 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 @. |
/authentication/user-name/separator2 |
string | @ | optional | read/write | 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 @. |
/authentication/user-name/suboption-id1 |
integer | 1 | optional | read/write | The relay-agent option (option 82) first suboption ID. The default is 1. |
/authentication/user-name/suboption-id2 |
integer | 2 | optional | read/write | The relay-agent option (option 82) second suboption ID. The default is 2. |
/authentication/user-name/tcl |
string | optional | read/write | 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. | |
/authentication/user-name/format |
string | mac-address | optional | read/write | 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. |
/authentication/user-name/separator1 |
string | @ | optional | read/write | 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 @. |
/authentication/user-name/separator2 |
string | @ | optional | read/write | 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 @. |
/authentication/user-name/suboption-id1 |
integer | 1 | optional | read/write | The relay-agent option (option 82) first suboption ID. The default is 1. |
/authentication/user-name/suboption-id2 |
integer | 2 | optional | read/write | The relay-agent option (option 82) second suboption ID. The default is 2. |
/authentication/user-name/tcl |
string | optional | read/write | 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. | |
/authentication/enabled |
string | false | optional | read/write | To enable or disable subscriber authentication. If enabled, then user has to fill the following fields. Default is false. |
/authentication/virtual |
string | optional | read/write | Specifies the authentication virtual server name. | |
/relay-agent-id |
array_structure | optional | read/write | ||
/relay-agent-id/add |
string | false | optional | read/write | Specifies if the user wants the DHCP relay agent to insert option 82 or not. Default is false. |
/relay-agent-id/remove |
string | false | optional | read/write | Specifies if the user wants the DHCP relay agent to remove option 82 from the server-to-client traffic or not. Default is false |
/relay-agent-id/suboptions |
array_structure | optional | read/write | ||
/relay-agent-id/suboptions/id1 |
integer | 1 | optional | read/write | An integer to represent the first suboption ID. Default is 1. |
/relay-agent-id/suboptions/id2 |
integer | optional | read/write | An integer to represent the second suboption ID. Default is 2. | |
/relay-agent-id/suboptions/value1 |
string | 2 | optional | read/write | A string to represent the first suboption value. |
/relay-agent-id/suboptions/value2 |
string | optional | read/write | A string to represent the second suboption value. | |
/relay-agent-id/suboptions/id1 |
integer | 1 | optional | read/write | An integer to represent the first suboption ID. Default is 1. |
/relay-agent-id/suboptions/id2 |
integer | optional | read/write | An integer to represent the second suboption ID. Default is 2. | |
/relay-agent-id/suboptions/value1 |
string | 2 | optional | read/write | A string to represent the first suboption value. |
/relay-agent-id/suboptions/value2 |
string | optional | read/write | A string to represent the second suboption value. | |
/relay-agent-id/add |
string | false | optional | read/write | Specifies if the user wants the DHCP relay agent to insert option 82 or not. Default is false. |
/relay-agent-id/remove |
string | false | optional | read/write | Specifies if the user wants the DHCP relay agent to remove option 82 from the server-to-client traffic or not. Default is false |
/subscriber-discovery |
array_structure | optional | read/write | ||
/subscriber-discovery/enabled |
string | false | optional | read/write | To enable or disable subscriber discovery. If enabled, then user has to fill the following fields. Default is false. |
/subscriber-discovery/subscriber-id |
array_structure | optional | read/write | ||
/subscriber-discovery/subscriber-id/format |
string | mac-address | optional | read/write | 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. |
/subscriber-discovery/subscriber-id/separator1 |
string | @ | optional | read/write | A string that is used to concatenate the MAC address and the relay-agent info option (option 82) to create the spm subscriber-id. The default is @. |
/subscriber-discovery/subscriber-id/separator2 |
string | @ | optional | read/write | A string that is used to concatenate the relay-agent info option (option 82) suboptions 1 and 2 to create the spm subscriber-id. The default is @. |
/subscriber-discovery/subscriber-id/suboption-id1 |
integer | 1 | optional | read/write | The relay-agent option (option 82) first suboption ID. The default is 1. |
/subscriber-discovery/subscriber-id/suboption-id2 |
integer | 2 | optional | read/write | The relay-agent option (option 82) second suboption ID. The default is 2. |
/subscriber-discovery/subscriber-id/tcl |
string | optional | read/write | 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. | |
/subscriber-discovery/subscriber-id/format |
string | mac-address | optional | read/write | 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. |
/subscriber-discovery/subscriber-id/separator1 |
string | @ | optional | read/write | A string that is used to concatenate the MAC address and the relay-agent info option (option 82) to create the spm subscriber-id. The default is @. |
/subscriber-discovery/subscriber-id/separator2 |
string | @ | optional | read/write | A string that is used to concatenate the relay-agent info option (option 82) suboptions 1 and 2 to create the spm subscriber-id. The default is @. |
/subscriber-discovery/subscriber-id/suboption-id1 |
integer | 1 | optional | read/write | The relay-agent option (option 82) first suboption ID. The default is 1. |
/subscriber-discovery/subscriber-id/suboption-id2 |
integer | 2 | optional | read/write | The relay-agent option (option 82) second suboption ID. The default is 2. |
/subscriber-discovery/subscriber-id/tcl |
string | optional | read/write | 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. | |
/subscriber-discovery/enabled |
string | false | optional | read/write | To enable or disable subscriber discovery. If enabled, then user has to fill the following fields. Default is false. |
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.
The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.
