kyvernon ip-pools

`kyvernon ip-pools`

Public IP pools on host-bridge networks and their allocations

Usage

kyvernon ip-pools <COMMAND>

Subcommands: list, get, create, update, delete, allocations, available, allocate, free, ptr, ptr-applied, ptr-rejected

`kyvernon ip-pools list`

List pools with their usage

Usage

kyvernon ip-pools list

API operation: GET /v1/ip-pools

`kyvernon ip-pools get`

One pool

Usage

kyvernon ip-pools get <ID>

Argument	Description	Required
`<ID>`	Pool id	yes

API operation: GET /v1/ip-pools/{id}

`kyvernon ip-pools create`

Create a pool

Usage

kyvernon ip-pools create [OPTIONS]

Argument	Description	Required
`--name`	Pool name	yes
`--network`	Host-bridge network id (`network-N`)	yes
`--prefix-len`	Prefix length of the IPv4 subnet	yes
`--range`	IPv4 range `start-end` (repeat)
`--address`	Single IPv4 address of the subnet (repeat; a provider's on-link addresses)
`--gateway`	Gateway
`--dns`	DNS server (repeat)
`--reserved`	Address never handed out (repeat)
`--ipv6-prefix`	IPv6 prefix `prefix/len` (32 to 127, shorter than the block length)
`--ipv6-block-len`	Length of every server's IPv6 block, 64 to 128 (default 64; 112 for a /112 per VPS)
`--ipv6-reserved`	IPv6 address inside the prefix used by others, e.g. the host's (repeat)
`--ipv6-gateway`	IPv6 gateway of the guests (the router's link-local or on-link address)
`--quarantine-s`	Quarantine of released addresses in seconds
`--smtp-ipv4`	Outgoing SMTP over IPv4: `allowed` (default) or `blocked`
`--smtp-ipv6`	Outgoing SMTP over IPv6: `blocked` (default) or `allowed`
`--rdns`	Reverse DNS: `provider` (default) or `manual` (an operator applies requests)

API operation: POST /v1/ip-pools

`kyvernon ip-pools update`

Replace a pool's definition (allocations are kept)

Usage

kyvernon ip-pools update [OPTIONS] <ID>

Argument	Description	Required
`<ID>`	Pool id	yes
`--name`	Pool name	yes
`--network`	Host-bridge network id (`network-N`)	yes
`--prefix-len`	Prefix length of the IPv4 subnet	yes
`--range`	IPv4 range `start-end` (repeat)
`--address`	Single IPv4 address of the subnet (repeat; a provider's on-link addresses)
`--gateway`	Gateway
`--dns`	DNS server (repeat)
`--reserved`	Address never handed out (repeat)
`--ipv6-prefix`	IPv6 prefix `prefix/len` (32 to 127, shorter than the block length)
`--ipv6-block-len`	Length of every server's IPv6 block, 64 to 128 (default 64; 112 for a /112 per VPS)
`--ipv6-reserved`	IPv6 address inside the prefix used by others, e.g. the host's (repeat)
`--ipv6-gateway`	IPv6 gateway of the guests (the router's link-local or on-link address)
`--quarantine-s`	Quarantine of released addresses in seconds
`--smtp-ipv4`	Outgoing SMTP over IPv4: `allowed` (default) or `blocked`
`--smtp-ipv6`	Outgoing SMTP over IPv6: `blocked` (default) or `allowed`
`--rdns`	Reverse DNS: `provider` (default) or `manual` (an operator applies requests)

API operation: PUT /v1/ip-pools/{id}

`kyvernon ip-pools delete`

Delete a pool without allocations

Usage

kyvernon ip-pools delete <ID>

Argument	Description	Required
`<ID>`	Pool id	yes

API operation: DELETE /v1/ip-pools/{id}

`kyvernon ip-pools allocations`

Allocated and quarantined addresses

Usage

kyvernon ip-pools allocations <ID>

Argument	Description	Required
`<ID>`	Pool id	yes

API operation: GET /v1/ip-pools/{id}/allocations

`kyvernon ip-pools available`

Free IPv4 addresses (the first one is what allocate takes) and the number of free IPv4 addresses and IPv6 blocks

Usage

kyvernon ip-pools available [OPTIONS] <ID>

Argument	Description	Required
`<ID>`	Pool id	yes
`--limit`	Most addresses listed (default 256, at most 4096)

API operation: GET /v1/ip-pools/{id}/available

`kyvernon ip-pools allocate`

Allocate an address (or a /64) and bind it to a VM NIC

Usage

kyvernon ip-pools allocate [OPTIONS] <ID>

Argument	Description	Required
`<ID>`	Pool id	yes
`--vm`	VM to bind to
`--mac`	NIC MAC (default: the VM's first NIC on the pool's network)
`--address`	A specific IPv4 address
`--extra`	An extra address (not the primary one)
`--ipv6`	A /64 instead of an IPv4 address
`--tenant`	Tenant (quota)
`--reference`	Order reference

API operation: POST /v1/ip-pools/{id}/allocations

`kyvernon ip-pools free`

Return an address (or prefix/64) to the pool

Usage

kyvernon ip-pools free <ID> <ADDRESS>

Argument	Description	Required
`<ID>`	Pool id	yes
`<ADDRESS>`	Address	yes

API operation: DELETE /v1/ip-pools/{id}/allocations/{address}

`kyvernon ip-pools ptr`

Set (or with no --name remove) the PTR name of an address

Usage

kyvernon ip-pools ptr [OPTIONS] <ID> <ADDRESS>

Argument	Description	Required
`<ID>`	Pool id	yes
`<ADDRESS>`	Address	yes
`--name`	Host name

API operation: PUT /v1/ip-pools/{id}/allocations/{address}/ptr

`kyvernon ip-pools ptr-applied`

Manual rDNS: the PTR request of an address is applied (or its removal done)

Usage

kyvernon ip-pools ptr-applied <ID> <ADDRESS>

Argument	Description	Required
`<ID>`	Pool id	yes
`<ADDRESS>`	Address (IPv4, or the server address of an IPv6 block)	yes

API operation: POST /v1/ip-pools/{id}/allocations/{address}/ptr/applied

`kyvernon ip-pools ptr-rejected`

Manual rDNS: the PTR request of an address could not be applied

Usage

kyvernon ip-pools ptr-rejected [OPTIONS] <ID> <ADDRESS>

Argument	Description	Required
`<ID>`	Pool id	yes
`<ADDRESS>`	Address	yes
`--reason`	Why (shown to the tenant)	yes

API operation: POST /v1/ip-pools/{id}/allocations/{address}/ptr/rejected