Documentation
Sign inGet started

bird email ip-pools update

Usage

Codebeispiel
bird email ip-pools update <ip-pool-id> [flags]

Description

Update an IP pool
Rename an IP pool or make it the organization default. Setting is_default true moves the default to this pool; the default is moved, never cleared, so setting is_default false on the current default is rejected. Pass ipp_shared to make the shared pool the default.
Build the request from flags, a JSON IPPoolUpdate body via --body-file ("-" reads stdin), or both — a flag overrides the matching body field. Run --example to print a ready-to-edit body, or --dry-run to print the resolved request without sending it.

Examples

Codebeispiel
# print the body shape (no credentials needed)
bird email ip-pools update --example

# the body it prints:
Codebeispiel
{
  "name": "Marketing"
}

Options

Pool

NameDescription
--nameThe pool's name.
--is-defaultMake this pool the organization's default. The default moves to this pool; it is never cleared.

Request

NameDescription
--body-fileRead the JSON request body from this file; "-" reads stdin
--examplePrint a complete example request body, then exit
--dry-runPrint the resolved request without sending it, then exit
--idempotency-keyDeduplication key; a retry with the same key won't act twice

Options

NameDescription
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird email ip-pools createCreate an IP pool
bird email ip-pools deleteDelete an IP pool
bird email ip-pools getGet an IP pool
bird email ip-pools listList IP pools