APIRef_tm_ltm_profile_dhcpv6ΒΆ
mgmt/tm/ltm/profile/dhcpv6
Dynamic Host Configuration Protocol, DHCPv6, profile to manage DHCPv6 network traffic.
REST Endpoints
- Collection URI
/mgmt/tm/ltm/profile/dhcpv6- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/ltm/profile/dhcpv6/~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 DHCPv6 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. |
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 DHCPv6 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 DHCPv6 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. |
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, option37, MAC + option37, option38, MAC + option38, option37 + option38, mac + option37 + option38 tcl-snippet. The concatenation symbols are defined as separator1 and separator2. |
/authentication/user-name/separator1 |
string | @ | optional | read/write | A string that is used to concatenate to the first two strings of the authentication user-name. The default is @. |
/authentication/user-name/separator2 |
string | @ | optional | read/write | A string that is used to concatenate to the second two strings of the authentication user-name. The default is @. |
/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, option37, MAC + option37, option38, MAC + option38, option37 + option38, mac + option37 + option38 tcl-snippet. The concatenation symbols are defined as separator1 and separator2. |
/authentication/user-name/separator1 |
string | @ | optional | read/write | A string that is used to concatenate to the first two strings of the authentication user-name. The default is @. |
/authentication/user-name/separator2 |
string | @ | optional | read/write | A string that is used to concatenate to the second two strings of the authentication user-name. The default is @. |
/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. | |
/remote-id-option |
array_structure | optional | read/write | ||
/remote-id-option/add |
string | false | optional | read/write | Specifies if the user wants the DHCP relay agent to insert option 37 or not. Default is false. |
/remote-id-option/enterprise-number |
integer | optional | read/write | Specifies the enterprise number of the inserted remote-id option (option 37). | |
/remote-id-option/remove |
string | false | optional | read/write | Specifies if the user wants the DHCP relay agent to remove option 37 or not. Default is false. |
/remote-id-option/value |
string | optional | read/write | A string to represent the remote-id option value. | |
/remote-id-option/add |
string | false | optional | read/write | Specifies if the user wants the DHCP relay agent to insert option 37 or not. Default is false. |
/remote-id-option/enterprise-number |
integer | optional | read/write | Specifies the enterprise number of the inserted remote-id option (option 37). | |
/remote-id-option/remove |
string | false | optional | read/write | Specifies if the user wants the DHCP relay agent to remove option 37 or not. Default is false. |
/remote-id-option/value |
string | optional | read/write | A string to represent the remote-id option value. | |
/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, option37, MAC + option37, option38, MAC + option38, option37 + option38, mac + option37 + option38 tcl-snippet. The concatenation symbols are defined as separator1 and separator2. |
/subscriber-discovery/subscriber-id/separator1 |
string | @ | optional | read/write | A string that is used to concatenate to the first two strings of the authentication subscriber-id. The default is @. |
/subscriber-discovery/subscriber-id/separator2 |
string | @ | optional | read/write | A string that is used to concatenate to the second two strings of the authentication subscriber-id. The default is @. |
/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, option37, MAC + option37, option38, MAC + option38, option37 + option38, mac + option37 + option38 tcl-snippet. The concatenation symbols are defined as separator1 and separator2. |
/subscriber-discovery/subscriber-id/separator1 |
string | @ | optional | read/write | A string that is used to concatenate to the first two strings of the authentication subscriber-id. The default is @. |
/subscriber-discovery/subscriber-id/separator2 |
string | @ | optional | read/write | A string that is used to concatenate to the second two strings of the authentication subscriber-id. The default is @. |
/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. |
/subscriber-id-option |
array_structure | optional | read/write | ||
/subscriber-id-option/add |
string | false | optional | read/write | Specifies if the user wants the DHCP relay agent to insert option 38 or not. Default is false. |
/subscriber-id-option/remove |
string | false | optional | read/write | Specifies if the user wants the DHCP relay agent to remove option 38 or not. Default is false. |
/subscriber-id-option/value |
string | optional | read/write | A string to represent the subscriber-id option value. | |
/subscriber-id-option/add |
string | false | optional | read/write | Specifies if the user wants the DHCP relay agent to insert option 38 or not. Default is false. |
/subscriber-id-option/remove |
string | false | optional | read/write | Specifies if the user wants the DHCP relay agent to remove option 38 or not. Default is false. |
/subscriber-id-option/value |
string | optional | read/write | A string to represent the subscriber-id option value. |
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.