VLAN Group State¶
Overview¶
You can use the VLAN Group State API to query VLAN group configuration objects in BIG-IQ. To perform management tasks to create, update and replace VLAN group configuration objects, you can use the VLAN Group Management API.
REST Endpoint: /mgmt/cm/adc-core/working-config/net/vlan-group¶
Requests¶
GET /mgmt/cm/adc-core/working-config/net/vlan-group/{id}¶
To retrieve the profile of a single VLAN group configuration object, you can send a GET request specified by its identifier.
Request Parameters¶
None
Query Parameters¶
None
Response¶
The JSON in the response can contain the following parameters.
HTTP/1.1 200 OK
| Name | Type | Description |
|---|---|---|
| autoLasthop | string | Specifies whether Auto Last Hop is enabled or disabled. The possible values are: “default”, “enabled”, or “disabled”. “default” uses the default of the next level. Auto Last Hop is used to track the source MAC address of incoming connections and the default is to be enabled for most network configurations |
| bridgeInStandby | boolean | If true this is enabled, which specifies that the VLAN group forward packets even if the system is the standby device in a redundant system. Note that this setting is only intended for deployments in which the VLAN group exists on only one of the devices. If the VLAN group exists on more than one device, this should be disabled by setting the field to false. The default value is false. |
| bridgeMulticast | boolean | Enables bridging of non-Internet Protocol (IP) and Address Resolution Protocol (ARP) multicast frames across the VLAN group. If bridgeMulticast is true, there can be bridging of multicast frames. For example, you may want to enable this if implementing the Spanning Tree Protocol (STP). The default is false. |
| bridgeTraffic | boolean | If true this is enabled and the VLAN group forwards all frames including non-IP traffic. The default is false to disable. |
| description | string | Description of the VLAN group. |
| deviceReference | object | Reference to the BIG-IP being targeted by the request. |
| id | string | The uuid identifier for the BIG-IP being targeted by the request. |
| link | string | This is a url for the BIG-IP being targeted by the request. You should call the Device Reference Helper API to get the correct value. |
| machineId | string | The machine id of the BIG-IP being targeted by the request. |
| name | string | Reference to the BIG-IP being targeted by the request. For example, “big-ip.example.com”. |
| id | string | Uuid identifier of the VLAN group configuration object. |
| migrationKeepalive | boolean | The system sends keepalive frames if migrationKeepalive is true and all the connections to a node are moved from one vlan-group member to another vlan-group member. The default value is false for disabled. |
| mode | string | The level of exposure of remote MAC addresses within VLAN groups. Possible values are: “transparent”, “translucent”, “opaque”, or “virtual-wire”. The default value is “translucent”. |
| name | string | Name for the VLAN group, for example “vlanGroup1”. |
| partition | string | Partition for the VLAN group, for example “Common”. |
| subPath | string | Path for VLAN group |
| tunnelReferences | object array | The names of the tunnels you want to add or remove from the VLAN group. |
| id | string | Uuid of the tunnel you want to add or remove from the VLAN group. |
| link | string | Url of the tunnel you want to add or remove from the VLAN group. |
| name | string | The name of the tunnel you want to add or remove from the VLAN group. For example, “tunnel1” |
| partition | string | The partition of the tunnel you want to add or remove from the VLAN group. For example, “Common”. |
| vlanReferences | object array | The VLANs you want to add or remove from the VLAN group. |
| id | string | Uuid of the VLANs you want to add or remove from the VLAN group. |
| link | string | Url of the VLAN you want to add or remove from the VLAN group. |
| name | string | Name of the VLAN you want to add or remove from the VLAN group. For example, “vlan1”. |
| partition | string | Partition of the VLAN you want to add or remove from the VLAN group. For example, “Common” |
| vwirePropagateLinkstatus | boolean | Enable virtual wire propagate link status. Available with BIG-IP 14.0.0 and later. Default value is false for disable. |
Permissions¶
| Role | Allow |
|---|---|
| ADC_Common_Editor | Yes |
| ADC_Common_Viewer | Yes |
| Trust_Discovery_Import | Yes |
| Virtual_Server_Operator | Yes |
GET /mgmt/cm/adc-core/working-config/net/vlan-group¶
To retrieve a list of all VLAN group configuration objects you can send a GET request to the vlan-group collection.
Request Parameters¶
None
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
The JSON in the response can contain the same parameters as for the individual VLAN group.
Permissions¶
| Role | Allow |
|---|---|
| ADC_Common_Editor | Yes |
| ADC_Common_Viewer | Yes |
| Trust_Discovery_Import | Yes |
| Virtual_Server_Operator | Yes |
Examples¶
None