Skip to main content

Aliases

Define groups of network infrastructure elements or packet header values.OpenAPI: YAML | JSON

An Alias (or Object) is a flexible way to group infrastructure elements (like network devices, interfaces, and end hosts) or packet header values (like VLAN IDs, IP addresses, and L4 ports). Aliases simplify the definition of policy checks and help when searching the network.

Here are some examples of Alias definitions in JSON.

Alias TypeJSONNotes
Devices
{
  "name": "tor_switches",
  "type": "DEVICES",
  "values": ["dc?-tor*", "tor-*"]
 }

The values are device names and/or name patterns containing glob wildcards (e.g. *,?, [abc], [0‑9]).

Interfaces
{
  "name": "vlan_20_access",
  "type": "INTERFACES",
  "values": ["SF-ACC-0-8 et[12]"]
}

The values are device interface names and/or name patterns. Each name or pattern must contain exactly one space, which separates the device name part from the interface name part.

{
  "name": "vlan_20_to_29_access",
  "type": "INTERFACES",
  "vlanIds": ["20-29"],
  "vlanIntfTypes": ["ACCESS"]
}

It can be convenient to define a set of device interfaces using a set of VLAN IDs. vlanIntfTypes can be ["TRUNK"], ["ACCESS"] or omitted (for both). If values is also present, it further restricts the set of matching interfaces.

Hosts
{
  "name": "web_servers",
  "type": "HOSTS",
  "values": ["10.30.1.0/24"],
  "locations": ["tor_switches"]
}

The values are host names, IP subnets and/or MAC addresses. The locations are device or interface names or aliases. At least one of locations and values must be specified.

Header Values
{
  "name": "VOIP",
  "type": "HEADERS",
  "values": {
    "eth_type": ["0x800"],
    "ip_proto": ["UDP"],
    "tp_port": ["10000", "20000"]
  }
}

Supported header types are:

  • mac_addr - MAC addresses
  • eth_type - Ethernet types
  • vlan_vid - VLAN IDs/ranges
  • ip_addr - IP addresses/blocks
  • ip_proto - IP protocols
  • tp_port - L4 ports/ranges

At least one type must be specified.

The resources below are for reading, creating, updating and deleting the Aliases associated with a network Snapshot. Changes to a Snapshot’s Aliases propagate forward to later Snapshots, including future Snapshots.

Get all Aliases
/api/snapshots/:snapshotId/aliases
Delete Aliases
/api/snapshots/:snapshotId/aliases
Get an Alias
/api/snapshots/:snapshotId/aliases/:name
Create an Alias
/api/snapshots/:snapshotId/aliases/:name
Delete an Alias
/api/snapshots/:snapshotId/aliases/:name