Traffic Management: IP Group

Endpoints

• Display IP groups : GET /api2/tm/rulesets/$/ip_group viewer
  • Json structure
• Display a specific IP group : GET /api2/tm/rulesets/$/ip_group/$ viewer
• Create new IP group : POST /api2/tm/rulesets/$/ip_group user
  • Json structure
• Edit IP group : PUT /api2/tm/rulesets/$/ip_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 IP group : DELETE /api2/tm/rulesets/$/ip_group/$ user

Dry-run preview

PUT /api2/tm/rulesets/$/ip_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

IP Group json structure

List type (IPv4)

[
    {
        "id": 1,
        "name": "web_servers",
        "set_id": 2,
        "type": "list",
        "ip_version": "ipv4",
        "data": {
            "values": ["192.168.1.1", "192.168.1.2", "192.168.1.3"]
        }
    }
]

List type (IPv6)

[
    {
        "id": 1,
        "name": "ipv6_servers",
        "set_id": 2,
        "type": "list",
        "ip_version": "ipv6",
        "data": {
            "values": ["2001:db8::1", "2001:db8::2"]
        }
    }
]

Range type

[
    {
        "id": 1,
        "name": "dhcp_range",
        "set_id": 2,
        "type": "range",
        "ip_version": "ipv4",
        "data": {
            "first": "192.168.1.100",
            "last": "192.168.1.200"
        }
    }
]

CIDR type

[
    {
        "id": 1,
        "name": "internal_network",
        "set_id": 2,
        "type": "cidr",
        "ip_version": "ipv4",
        "data": {
            "addr": "10.0.0.0",
            "cidr_mask": 24
        }
    }
]

Mask type

[
    {
        "id": 1,
        "name": "subnet_filter",
        "set_id": 2,
        "type": "mask",
        "ip_version": "ipv4",
        "data": {
            "type": "ipv4",
            "val": "192.168.0.0",
            "mask": "255.255.0.0"
        }
    }
]

An IP 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