Traffic Management: L4 Port Group

Endpoints

• Display l4 port groups : GET /api2/tm/rulesets/$/l4_port_group viewer
  • Json structure
• Display a specific l4 port group : GET /api2/tm/rulesets/$/l4_port_group/$ viewer
• Create new l4 port group : POST /api2/tm/rulesets/$/l4_port_group user
  • Json structure
  • x2 family, active ruleset: the group is sent to the network module at once, and the response also includes an nm_response field with the result.
• Edit l4 port group : PUT /api2/tm/rulesets/$/l4_port_group/$ user
  • Json structure
  • The response also includes an nm_response field with the network module's redeployment result when the edit changes the ports the group covers, the ruleset is active, and:
    • x2 family: always — the network module holds the group itself, and the whole ruleset is redeployed.
    • other families: an enabled rule or traffic chain references the group — only the affected entries are redeployed.
• Delete LAG : DELETE /api2/tm/rulesets/$/l4_port_group/$ user
  • x2 family, active ruleset: the whole ruleset is redeployed to drop the group from the network module, and the response also includes an nm_response field with the result.

Dry-run preview

PUT /api2/tm/rulesets/$/l4_port_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. When the edit changes what the rule-set costs, the 200 body is instead the resource cost report described in Chain Management (rules, chains and total; both arrays are always present).

Json structures

L4 Port 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
        }
    }
]

Restrictions

• The groups of a rule-set must be disjoint: a group whose ports overlap those of another group of the same rule-set is refused with a 400 (l4_port_group_intersection on ports, naming the other group). A group's name must also be unique within its rule-set.
• A group that a traffic rule or a traffic chain entry still names in its filters cannot be deleted; the response lists the rules and chains that use it.

Back to X2-SERIES API Home