APIRef_tm_net_vlanΒΆ
mgmt/tm/net/vlan
VLAN configuration and statistics
REST Endpoints
- Collection URI
/mgmt/tm/net/vlan- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/net/vlan/~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 that the object belongs to. | |
autoLasthop |
string | default | optional | read/write | Specifies whether auto lasthop is enabled or not. The default is to use next levels default. |
cmpHash |
string | default | optional | read/write | Specifies the cmp hash applied to the traffic on the vlan. |
customerTag |
string | optional | read/write | Specifies a number that the system adds into the header of any frame passing through the QinQ VLAN. | |
dagRoundRobin |
string | disabled | optional | read/write | Specifies whether some of the stateless traffic on the VLAN should be disaggregated in a round-robin order. |
dagTunnel |
string | outer | optional | read/write | Specifies whether the ip tunnel traffic on the VLAN should be disaggregated based on the inner ip header or outer ip header. The default value is outer. |
description |
string | optional | read/write | User defined description. | |
failsafe |
string | disabled | optional | read/write | Enables a fail-safe mechanism that causes the active unit to fail over to a redundant unit when loss of traffic is detected on a VLAN, and traffic is not restored during the failover timeout period for that VLAN. The default action set with VLAN fail-safe is restart all. When the fail-safe mechanism is triggered, all the daemons are restarted and the unit fails over. The default value is disable. |
failsafeAction |
string | failover-restart-tm | optional | read/write | Specifies the action that you want the system to take when it does not detect any traffic on this VLAN, and the timeout has expired. |
failsafeTimeout |
integer | 90 | optional | read/write | Specifies the number of seconds that an active unit can run without detecting network traffic on this VLAN before it initiates a failover. The default value is 90 seconds. |
hardwareSyncookie |
string | disabled | optional | read/write | Enables hardware syncookie mode on a VLAN. When enabled, the hardware per-VLAN SYN cookie protection will be triggered when the certain traffic threshold is reached on supported platforms. The default value is disabled. |
ifIndex |
integer | 0 | optional | read/write | Displays the index assigned to this VLAN. It is a unique identifier assigned for all objects displayed in the SNMP IF-MIB. |
learning |
string | enable-forward | optional | read/write | Specifies whether switch ports placed in the VLAN are configured for switch learning, forwarding only, or dropped. The default value is enable. |
mtu |
integer | 1500 | optional | read/write | Sets a specific maximum transmission unit (MTU) for the VLAN. The default value is 1500. |
tmPartition |
string | Common | optional | read/write | Displays the administrative partition within which the vlan resides. |
sourceChecking |
string | disabled | optional | read/write | Specifies that only connections that have a return route in the routing table are accepted. The default value is disable. |
synFloodRateLimit |
integer | 1000 | optional | read/write | Specifies the max number of SYN flood packets per second received on the VLAN before the hardware per-VLAN SYN cookie protection is triggered. The default value is set at 1000 packets per second. |
syncacheThreshold |
integer | 6000 | optional | read/write | Specifies the number of outstanding SYN packets on the VLAN that will trigger the hardware per-VLAN SYN cookie protection. The default value is set to 6000 packets. |
tag |
integer | 0 | optional | read/write | Specifies a number that the system adds into the header of any frame passing through the VLAN. |
Subcollections
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
interfaces |
array_structure | optional | read/write | Specifies which interfaces you want this VLAN to use for traffic management. |
Structures
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
/sflow |
array_structure | optional | read/write | ||
/sflow/poll-interval |
integer | 0 | optional | read/write | Specifies the maximum interval in seconds between two pollings. To enable this setting, you must also set the poll-interval-global setting to no. |
/sflow/poll-interval-global |
string | yes | optional | read/write | Specifies whether the global VLAN poll-interval setting overrides the object-level poll-interval setting. The default value is yes. |
/sflow/sampling-rate |
integer | 0 | optional | read/write | Specifies the ratio of packets observed to the samples generated. For example, a sampling rate of 2000 specifies that 1 sample will be randomly generated for every 2000 packets observed. To enable this setting, you must also set the sampling-rate-global setting to no. |
/sflow/sampling-rate-global |
string | yes | optional | read/write | Specifies whether the global VLAN sampling-rate setting overrides the object-level sampling-rate setting. The default value is yes. |
/sflow/poll-interval |
integer | 0 | optional | read/write | Specifies the maximum interval in seconds between two pollings. To enable this setting, you must also set the poll-interval-global setting to no. |
/sflow/poll-interval-global |
string | yes | optional | read/write | Specifies whether the global VLAN poll-interval setting overrides the object-level poll-interval setting. The default value is yes. |
/sflow/sampling-rate |
integer | 0 | optional | read/write | Specifies the ratio of packets observed to the samples generated. For example, a sampling rate of 2000 specifies that 1 sample will be randomly generated for every 2000 packets observed. To enable this setting, you must also set the sampling-rate-global setting to no. |
/sflow/sampling-rate-global |
string | yes | optional | read/write | Specifies whether the global VLAN sampling-rate setting overrides the object-level sampling-rate setting. The default value is yes. |
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.