Traffic Management: VLAN Group

Endpoints

• Display vlan groups : GET /api2/tm/rulesets/$/vid_group viewer
  • Json structure
• Display a specific vlan group : GET /api2/tm/rulesets/$/vid_group/$ viewer
• Create new vlan group : POST /api2/tm/rulesets/$/vid_group user
  • Json structure
• Edit vlan group : PUT /api2/tm/rulesets/$/vid_group/$ user
  • Json structure
  • If the group is referenced by a rule in the active ruleset, the response also includes an nm_response field with the network module's redeployment result.
• Delete vlan group : DELETE /api2/tm/rulesets/$/vid_group/$ user

Dry-run preview

PUT /api2/tm/rulesets/$/vid_group/$ accepts an optional ?dry_run=true query parameter. With the flag set, the handler runs all the same checks as the non-dry-run call but does not persist to the DAO and does not push to the network module. Returns 200 {} on success; error responses (status code and body) are identical to the non-dry-run call.

Json structures

VLAN Group json structure

[
    {
        "id": 1,
        "name": "name",
        "set_id": 2,
        "type": "list",
        "data": {
            "values": [1, 2, 3]
        }
    }
]

or

[
    {
        "id": 1,
        "name": "name",
        "set_id": 2,
        "type": "range",
        "data": {
            "first": 100,
            "last": 200
        }
    }
]

Back to X2-SERIES API Home