ip-profile set
Change a profile's rules, name or description.
Changes a profile's rules, its name or its description.
--rule replaces the whole list rather than adding to it, so send every rule the
profile should end up with. The change reaches every application using the profile
immediately, with no deployment.
Usage
outplane ip-profile set <PROFILE> [flags]Arguments
| Argument | Type | Description |
|---|---|---|
PROFILE | string | Profile name or id. Required. |
Flags
| Flag | Type | Description |
|---|---|---|
--rule | strings | CIDR[=description], repeatable. Replaces every existing rule. Repeatable. |
--name | string | Rename the profile. |
--description | string | What the profile is for. |
The global flags apply as well.
Output
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
description | string | null | |
rules | int | How many networks it allows. |
assignments | int | How many applications use it. |
ruleList | array | The networks themselves, {cidr, description}. Sorted, and JSON only. |
assignedApps | array | The applications using it, {id, app, appId}. id is the assignment's own id, which is what detaching needs. |
createdAt | string | null | RFC 3339, UTC. |
changed | bool | False for a dry run. |
Examples
See what the new list would be, and who it would affect
outplane ip-profile set office --rule 203.0.113.0/24 --dry-run --json{
"changed": false,
"name": "office",
"rules": 1
}Replace the rules
outplane ip-profile set office --rule 203.0.113.0/24 --rule 198.51.100.7/32=vpnChange only the description, leaving the rules alone
outplane ip-profile set office --description "head office and VPN" --json --fields rules,changedWhat to Know
- --rule replaces the entire list. Sending one rule to a profile that had four leaves it with one, and the other three are gone. --rule "" leaves none.
- A flag that is not given keeps its value: the endpoint replaces everything it is given, so this command reads the profile first and sends it back with the change applied.
- The change applies immediately to every application the profile is attached to, with no deployment. The result names them, and
ip-profile getnames them beforehand. - Sending no flags at all is refused with usage.no_change rather than being a request that rewrites the profile with itself.
Errors
Beyond 0 for success, this command exits with:
| Exit | Kind | Meaning |
|---|---|---|
2 | usage | Invalid arguments, unknown flag, or client-side validation failure. |
3 | auth | Not authenticated, token revoked or expired, or forbidden for this team. |
5 | not_found | The named resource does not exist, or is not visible to this credential. |
8 | upstream | The Out Plane API returned a server error. |
The code on the error object is one of ipprofile.not_found, ipprofile.name_invalid, ipprofile.description_invalid, ipprofile.cidr_invalid, ipprofile.rule_duplicate, usage.no_change, usage.missing_argument, context.no_team. Branch on that, or on the exit status. The message is prose and changes.