Create named sets

This guide describes how to create a named set in Cloud Router.

The examples on this page create two named sets of different types: a prefix set and a community set.

The prefix set is named allowed-prefixes and contains the following items:

'192.168.0.0/16'
'fd00::/8'
prefix('10.0.0.0/20').orLonger()

The community set is named allowed-communities contains the following items:

'64500:100'
'64500:200'

You can create named sets for Cloud Router in two ways:

Use Google Cloud CLI to build a named set
Use your preferred text editor to create a JSON or YAML file, and then use gcloud CLI to upload the named set

Build named sets

The names of the named sets must be unique within the router. This section builds named sets using the gcloud CLI.

Build a prefix set

To build a prefix set, do the following:

To create an empty prefix named set called allowed-prefixes, run the following command:
```
gcloud beta compute routers add-named-set ROUTER_NAME
    --set-name=allowed-prefixes
    --set-type=prefix
```
Replace ROUTER_NAME with the name of the Cloud Router.

To add each of the elements to the allowed-prefixes named set, run the add-named-set-element command for each element:

gcloud beta compute routers add-named-set-element ROUTER_NAME --set-name=allowed-prefixes --new-set-element="'192.168.0.0/16'"

gcloud beta compute routers add-named-set-element ROUTER_NAME --set-name=allowed-prefixes --new-set-element="'fd00::/8'"

gcloud beta compute routers add-named-set-element ROUTER_NAME --set-name=allowed-prefixes --new-set-element="prefix('10.0.0.0/20').orLonger()"

Build a community set

To build a community set, do the following:

To create an empty community set called allowed-communities, run the following command:

gcloud beta compute routers add-named-set ROUTER_NAME
    --set-name=allowed-communities
    --set-type=community

To add each of the elements to the allowed-communities named set, run the add-named-set-element command for each element:

gcloud beta compute routers add-named-set-element ROUTER_NAME --set-name=allowed-communities --new-set-element="'64500:100'"

gcloud beta compute routers add-named-set-element ROUTER_NAME --set-name=allowed-communities --new-set-element="'64500:200'"

Upload named sets

When creating a JSON or YAML file, use one of the following named set types:

NAMED_SET_TYPE_COMMUNITY
NAMED_SET_TYPE_PREFIX

The upload-named-set command overwrites any named set with the same name.

To create named sets called allowed-prefixes and allowed-communities, create the named sets in your preferred text editor. You can use YAML or JSON formatting to create them.

allowed-prefixes.yaml:

# Prefix set
resource:
  elements:
  - expression: "'192.168.0.0/16'"
  - expression: "'fd00::/8'"
  - expression: "prefix('10.0.0.0/20').orLonger()"
  name: allowed-prefixes
  type: NAMED_SET_TYPE_PREFIX

allowed-communities.yaml:

# Community set
resource:
  elements:
  - expression: "'64500:100'"
  - expression: "'64500:200'"
  name: allowed-communities
  type: NAMED_SET_TYPE_COMMUNITY

To upload the named sets, run the following commands:

gcloud beta compute routers upload-named-set ROUTER_NAME
    --set-name=allowed-prefixes
    --file-name=allowed-prefixes.yaml
    --file-format=json

gcloud beta compute routers upload-named-set ROUTER_NAME
    --set-name=allowed-communities
    --file-name=allowed-communities.json
    --file-format=json

Replace ROUTER_NAME with the name of the Cloud Router.

Prefix Set Elements

Elements of prefix sets must be either a prefix literal (string) or a prefix range object. These are the same prefix literal and prefix ranges defined for use in route policies.

The following table describes each element of a prefix set.

Expression	Description
`'192.168.0.0/24'`	Prefix literal.
`prefix('192.168.0.0/24')`	Prefix object.
`p.longer()`	Prefix range object that is a copy of p with the end of the range set to the input prefix's per-address family max (/32 or /128), and the start of the range set to the input prefix's length plus one.
`p.orLonger()`	Prefix range object that's a copy of p with the end of the range set to the input prefix's per-address family max (/32 or /128).
`p.lengthRange(20, 30)`	Prefix range object that's a copy of p with the start of the range set to /20, and the end set to /30.
`p.upTo(30)`	Prefix range object that's a copy of p with the end of the range set to the input prefix's /30.

Community Set Elements

Elements of community sets must be community strings in human readable A:B format.

The following table describes the elements of a community set.

Expression	Description
`'A:B'`	Community literal.

What's next

Update named sets