ipset - Control Plane

Manage IP Sets

cpln ipset [SUBCOMMAND]

Commands:
  cpln ipset access-report <ref>    Show the access report for the referenced ip set
  cpln ipset add-location <ref>     Add one or more locations to the referenced IP set
  cpln ipset audit [ref]            Retrieve audit trail events for the referenced ip set
  cpln ipset clone <ref>            Create a clone of the referenced ip set; this will only duplicate its spec.  [aliases: copy]
  cpln ipset create                 Create a new ip set
  cpln ipset delete <ref...>        Delete one or more referenced ip sets
  cpln ipset edit <ref>             Edit the referenced ip set, as YAML, within an editor
  cpln ipset eventlog <ref>         Show the event log of the referenced ip set  [aliases: log]
  cpln ipset get [ref...]           Retrieve one or more referenced ip set
  cpln ipset patch <ref>            Update the referenced ip set's metadata using an input file
  cpln ipset permissions            Show the grantable permissions for an ip set object type
  cpln ipset query                  Find all the ip sets based on the given query
  cpln ipset remove-location <ref>  Remove one or more locations from the referenced IP set
  cpln ipset tag <ref...>           Manage the tags belonging to one or more referenced ip sets
  cpln ipset update <ref>           Update properties of the referenced ip set
  cpln ipset update-location <ref>  Update one or more locations from the referenced IP set

Options:
  --help  Show help  [boolean]

ipset access-report

Show the access report for the referenced ip set Usage

cpln ipset access-report <ref> [OPTIONS]

Reference

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

cpln ipset access-report demo-ipset --org demo-cpln-organization

+-----------+--------------------------------------------------------+--------+
|PERMISSION |PRINCIPAL                                               |GRANTED |
|-----------|--------------------------------------------------------|--------|
|create     |/org/demo-cpln-organization/group/superusers            |manage  |
|create     |/org/demo-cpln-organization/serviceaccount/controlplane |manage  |
|delete     |/org/demo-cpln-organization/group/superusers            |manage  |
|delete     |/org/demo-cpln-organization/serviceaccount/controlplane |manage  |
|edit       |/org/demo-cpln-organization/group/superusers            |manage  |
|edit       |/org/demo-cpln-organization/serviceaccount/controlplane |manage  |
|manage     |/org/demo-cpln-organization/group/superusers            |manage  |
|manage     |/org/demo-cpln-organization/serviceaccount/controlplane |manage  |
|view       |/org/demo-cpln-organization/group/viewers               |view    |
|view       |/org/demo-cpln-organization/group/superusers            |manage  |
|view       |/org/demo-cpln-organization/serviceaccount/controlplane |manage  |
+-----------+--------------------------------------------------------+--------+

ipset add-location

Add one or more locations to the referenced IP set Usage

cpln ipset add-location <ref> [OPTIONS]

Reference

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]

Command options:
  --location  Add a location with an optional retention policy (`keep` or `free`), e.g., aws-eu-central-1,keep.  [required]
  --dry-run   Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim  [boolean]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

{COMMAND}

{CODE}

ipset audit

Retrieve audit trail events for the referenced ip set Usage

cpln ipset audit [ref] [OPTIONS]

Reference

Positionals:
  ref  The resource reference. Usually it is the name of the resource.

Command options:
  --subject  Filter by subject (serviceaccount name or user email)  [string]
  --context  Audit context name (the 'cpln' context displays Control Plane actions)  [string] [default: "cpln"]
  --since    Relative lookback window from now (e.g., 1h, 24h, 7d). Mutually exclusive with --from/--to  [string] [default: "7d"]
  --from     Start time for audit events (ISO 8601 format or relative duration, e.g., 2025-10-23T07:00:00Z, 7d, 1h). Cannot be used with --since  [string]
  --to       End time for audit events (ISO 8601 format or relative duration, e.g., 2025-10-23T07:00:00Z, 1d, 30m)  [string]

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Options:
  --help  Show help  [boolean]

Common Options Reference

ipset clone

Create a clone of the referenced ip set; this will only duplicate its spec. Usage

cpln ipset clone <ref> --name CLONE_NAME [OPTIONS]

Reference

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]

Command options:
  --name         Set the name for the clone  [required]
  --description  Optional description, defaults to the name if not set
  --tag          Attach tags (e.g., --tag drink=water)
  --dry-run      Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim  [boolean]

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

cpln ipset clone demo-ipset --name demo-ipset-clone --org demo-cpln-organization

+-----------------+--------------------+-----+----------+--------------+
|NAME             |DESCRIPTION         |LINK |LOCATIONS |TAGS          |
|-----------------|--------------------|-----|----------|--------------|
|demo-ipset-clone |Clone of demo-ipset |     |          |drink="water" |
+-----------------+--------------------+-----+----------+--------------+

ipset create

Create a new ip set Usage

cpln ipset create --name NAME [OPTIONS]

Reference

Command options:
  --name                 Name of the new volume set  [required]
  --description, --desc  Optional description, defaults to the name if not set
  --link                 A link to a workload
  --location             Specifies a location and optional retention policy (keep or free), e.g., aws-eu-central-1,keep
  --tag                  Attach tags (e.g., --tag drink=water)
  --dry-run              Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim  [boolean]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

cpln ipset create --name demo-ipset --desc demo-ipset --tag drink=water --org demo-cpln-organization

+-----------+------------+-----+----------+--------------+
|NAME       |DESCRIPTION |LINK |LOCATIONS |TAGS          |
|-----------|------------|-----|----------|--------------|
|demo-ipset |demo-ipset  |     |          |drink="water" |
+-----------+------------+-----+----------+--------------+

ipset delete

Delete one or more referenced ip sets Usage

cpln ipset delete <ref...> [OPTIONS]

Reference

Positionals:
  ref  One or more resource references. Usually it is the name of the resource.  [array] [required] [default: []]

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

cpln ipset delete demo-ipset --org demo-cpln-organization

If the delete was successful, a new command prompt will be shown.

ipset edit

Edit the referenced ip set, as YAML, within an editor Usage

cpln ipset edit <ref> [OPTIONS]

The default editor can be set by using the EDITOR environment variable.

Reference

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]

Command options:
  --replace, -r  Replace instead of patch/merge  [boolean] [default: false]
  --dry-run      Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim  [boolean]

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

cpln ipset edit demo-ipset --org demo-cpln-organization

Your default editor will be launched.

Once any modifications are saved, the updates will be sent to the API.

ipset eventlog

Show the event log of the referenced ip set Usage

cpln ipset eventlog <ref> [OPTIONS]

Reference

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

cpln ipset eventlog demo-ipset --org demo-cpln-organization

The event log for the referenced ipset will be shown.

ipset get

Retrieve one or more referenced ip set Usage

cpln ipset get [ref...] [OPTIONS]

An empty reference will return all references

Reference

Positionals:
  ref  One or more resource references. Usually it is the name of the resource.  [array] [default: []]

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

Get all ipsets

cpln ipset get --org demo-cpln-organization

+-----------------+-----------------+-----+----------+--------------+
|NAME             |DESCRIPTION      |LINK |LOCATIONS |TAGS          |
|-----------------|-----------------|-----|----------|--------------|
|demo-ipset       |demo-ipset       |     |          |drink="water" |
|demo-ipset-get-1 |demo-ipset-get-1 |     |          |              |
|demo-ipset-get-2 |demo-ipset-get-2 |     |          |              |
+-----------------+-----------------+-----+----------+--------------+

Get one ipset

cpln ipset get demo-ipset-get-1 --org demo-cpln-organization

+-----------------+-----------------+-----+----------+-----+
|NAME             |DESCRIPTION      |LINK |LOCATIONS |TAGS |
|-----------------|-----------------|-----|----------|-----|
|demo-ipset-get-1 |demo-ipset-get-1 |     |          |     |
+-----------------+-----------------+-----+----------+-----+

Get multiple ipsets

cpln ipset get demo-ipset-get-1 demo-ipset-get-2 --org demo-cpln-organization

+-----------------+-----------------+-----+----------+-----+
|NAME             |DESCRIPTION      |LINK |LOCATIONS |TAGS |
|-----------------|-----------------|-----|----------|-----|
|demo-ipset-get-1 |demo-ipset-get-1 |     |          |     |
|demo-ipset-get-2 |demo-ipset-get-2 |     |          |     |
+-----------------+-----------------+-----+----------+-----+

ipset patch

Update the referenced ip set’s metadata using an input file Usage

cpln ipset patch <ref> --file FILE_NAME [OPTIONS]

Running this command with the option --file - sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"} or description: My new description). To complete the update, press Control-D (or Control-Z if you are using Windows).

Reference

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]

Command options:
  --file, -f  File to load the patch from. Use `--file -` to enable input from stdin.  [required]
  --dry-run   Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim  [boolean]

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

cpln ipset patch demo-ipset --file update.json --org demo-cpln-organization

The changes within the JSON file will be performed against the referenced ipset.

ipset permissions

Show the grantable permissions for an ip set object type Usage

cpln ipset permissions [OPTIONS]

Reference

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

cpln ipset permissions --org demo-cpln-organization

+-------+--------------------------+-----------------------------------+
|NAME   |DESCRIPTION               |IMPLIES                            |
|-------|--------------------------|-----------------------------------|
|create |Create new ip sets        |                                   |
|delete |Delete ip sets            |                                   |
|edit   |Modify existing resources |view                               |
|manage |Full access               |create, delete, edit, manage, view |
|view   |Read-only access          |                                   |
+-------+--------------------------+-----------------------------------+

ipset query

Find all the ip sets based on the given query Usage

cpln ipset query QUERY_OPTIONS [OPTIONS]

Reference

Query options:
  --match             Query filter type  [choices: "all", "none", "any"] [default: "all"]
  --property, --prop  Property to query
  --tag               Tag to query
  --rel               Relation to query

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

Use the --match option to display all, none, or any of the results based on a given property or tag

Search for an ipset based on the name property

cpln ipset query --match any --prop name=demo-ipset --org demo-cpln-organization

+-----------+------------+-----+----------+--------------+
|NAME       |DESCRIPTION |LINK |LOCATIONS |TAGS          |
|-----------|------------|-----|----------|--------------|
|demo-ipset |demo-ipset  |     |          |drink="water" |
+-----------+------------+-----+----------+--------------+

Search for an ipset based on the description property

cpln ipset query --match any --prop description="demo-ipset" --org demo-cpln-organization

+-----------+------------+-----+----------+--------------+
|NAME       |DESCRIPTION |LINK |LOCATIONS |TAGS          |
|-----------|------------|-----|----------|--------------|
|demo-ipset |demo-ipset  |     |          |drink="water" |
+-----------+------------+-----+----------+--------------+

Search for an ipset based on a tag

cpln ipset query --match any --tag drink=water --org demo-cpln-organization

+-----------+------------+-----+----------+--------------+
|NAME       |DESCRIPTION |LINK |LOCATIONS |TAGS          |
|-----------|------------|-----|----------|--------------|
|demo-ipset |demo-ipset  |     |          |drink="water" |
+-----------+------------+-----+----------+--------------+

Search for an ipset based on a property and tag

cpln ipset query --match any --prop description="demo-ipset" --tag drink=water --org demo-cpln-organization

+-----------+------------+-----+----------+--------------+
|NAME       |DESCRIPTION |LINK |LOCATIONS |TAGS          |
|-----------|------------|-----|----------|--------------|
|demo-ipset |demo-ipset  |     |          |drink="water" |
+-----------+------------+-----+----------+--------------+

ipset remove-location

Remove one or more locations from the referenced IP set Usage

cpln ipset remove-location <ref> [OPTIONS]

Reference

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]

Command options:
  --location  Remove a location by name, e.g., aws-eu-central-1.  [required]
  --dry-run   Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim  [boolean]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

{COMMAND}

{CODE}

ipset tag

Manage the tags belonging to one or more referenced ip sets Usage

cpln ipset tag <ref...> --tag KEY=VALUE [OPTIONS]

Built-in tags, which begin with cpln/*, can’t be modified.

Reference

Positionals:
  ref  One or more resource references. Usually it is the name of the resource.  [array] [required] [default: []]

Command options:
  --tag         Attach tags (e.g., --tag drink=water)
  --remove-tag  Remove tags (e.g., --remove-tag tagname)
  --dry-run     Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim  [boolean]

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

Add a tag to an IP Set

{ADD_TAG_COMMAND}

{ADD_TAG_CODE}

Update same tag (after running the example above)

{UPDATE_TAG_COMMAND}

{UPDATE_TAG_CODE}

Remove tag (after running the example above)

{REMOVE_TAG_COMMAND}

{REMOVE_TAG_CODE}

Add same tag to multiple IP Sets

{ADD_TAG_MULTIPLE_COMMAND}

{ADD_TAG_MULTIPLE_CODE}

Update same tag on multiple IP Sets (after running the example above)

{UPDATE_TAG_MULTIPLE_COMMAND}

{UPDATE_TAG_MULTIPLE_CODE}

Remove same tag from multiple IP Sets (after running the example above)

{REMOVE_TAG_MULTIPLE_COMMAND}

{REMOVE_TAG_MULTIPLE_CODE}

ipset update

Update properties of the referenced ip set Usage

cpln ipset update <ref> --set UPDATE_PROPERTY [OPTIONS]

Reference

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]

Update Properties:
  --set    Update the following properties (e.g., --set description="Updated Description"):

           description    string
           tags.<key>     string
           spec.link      string
  --unset  Unset a property (same paths as --set, e.g., --unset description)

Command options:
  --dry-run  Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim  [boolean]

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

For the examples below, the initial IP Set is configured as:

{RESOURCE_CODE}

Update an IP Set’s description

{UPDATE_DESCRIPTION_COMMAND}

{UPDATE_DESCRIPTION_CODE}

Update an IP Set’s tags

{UPDATE_TAGS_COMMAND}

{UPDATE_TAGS_CODE}

Update an IP Set’s link

{UPDATE_LINK_COMMAND}

{UPDATE_LINK_CODE}

ipset update-location

Update one or more locations from the referenced IP set Usage

cpln ipset update-location <ref> [OPTIONS]

Reference

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]

Command options:
  --location  Add a location with an optional retention policy (`keep` or `free`), e.g., aws-eu-central-1,keep.  [required]
  --dry-run   Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim  [boolean]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

For the examples below, the initial IP Set is configured as:

{IPSET}

Update one or more locations from the referenced IP set wtih an optional retention policy (one of keep or free).

{UPDATE_LOCATION_COMMAND}

{UPDATE_LOCATION_CODE}

​ipset access-report

​ipset add-location

​ipset audit

​ipset clone

​ipset create

​ipset delete

​ipset edit

​ipset eventlog

​ipset get

​ipset patch

​ipset permissions

​ipset query

​ipset remove-location

​ipset tag

​ipset update

​ipset update-location

ipset access-report

ipset add-location

ipset audit

ipset clone

ipset create

ipset delete

ipset edit

ipset eventlog

ipset get

ipset patch

ipset permissions

ipset query

ipset remove-location

ipset tag

ipset update

ipset update-location