API schemas: P

PackageBody

Add a traffic package.

Name	Type	Required	Description
`bytes`	`integer` (int64)	yes	Bytes added to the current period's limit.
`reference`	`string` or `null`		Order reference; the same reference adds a package once per period.

Paged_AuditView

A page of items with the store version it was read at.

Name	Type	Required	Description
`items`	array of `object`	yes	Items in id order.
`next`	`string` or `null`		Cursor for the next page (`after` query parameter), absent on the last page.
`version`	`integer` (int64)	yes	Store version at read time; use as `since` for the change feed.

Paged_EventView

A page of items with the store version it was read at.

Name	Type	Required	Description
`items`	array of `object`	yes	Items in id order.
`next`	`string` or `null`		Cursor for the next page (`after` query parameter), absent on the last page.
`version`	`integer` (int64)	yes	Store version at read time; use as `since` for the change feed.

Paged_ObjectView

A page of items with the store version it was read at.

Name	Type	Required	Description
`items`	array of `ObjectViewDatacenter` or `ObjectViewDatacenterFolder` or `ObjectViewVmFolder` or `ObjectViewHostFolder` or `ObjectViewNetworkFolder` or `ObjectViewDatastoreFolder` or `ObjectViewCluster` or `ObjectViewComputeResource` or `ObjectViewHost` or `ObjectViewResourcePool` or `ObjectViewVirtualMachine` or `ObjectViewDatastore` or `ObjectViewNetwork` or `ObjectViewDistributedSwitch` or `ObjectViewDistributedPortgroup` or `ObjectViewTag` or `ObjectViewTagCategory` or `ObjectViewCustomField`	yes	Items in id order.
`next`	`string` or `null`		Cursor for the next page (`after` query parameter), absent on the last page.
`version`	`integer` (int64)	yes	Store version at read time; use as `since` for the change feed.

Paged_TaskView

A page of items with the store version it was read at.

Name	Type	Required	Description
`items`	array of `object`	yes	Items in id order.
`next`	`string` or `null`		Cursor for the next page (`after` query parameter), absent on the last page.
`version`	`integer` (int64)	yes	Store version at read time; use as `since` for the change feed.

PasswordPolicyRequest

Body of PUT /v1/identity/password-policy. Every password set after the change is checked against it; existing passwords stay valid. Passwords are also checked against the list of common passwords, for sequences and repetition and for the user name; those checks cannot be switched off.

Name	Type	Required	Description
`description`	`string` or `null`		Text for administrators (kept when absent).
`maxLength`	`integer`	yes	Longest password, at most `maxLengthCeiling` (256) and not below `minLength`.
`minLength`	`integer`	yes	Shortest password, at least `minLengthFloor` (12).

PasswordPolicyView

The local password policy.

Name	Type	Required	Description
`description`	`string`	yes	Text for administrators.
`maxLength`	`integer`	yes	Longest password accepted, in characters.
`maxLengthCeiling`	`integer`	yes	The largest value `maxLength` may take (fixed by the product).
`minLength`	`integer`	yes	Shortest password accepted, in characters.
`minLengthFloor`	`integer`	yes	The smallest value `minLength` may take (fixed by the product).

PendingModeView

A mode switch that waits for confirmation.

Name	Type	Required	Description
`revertAt`	`string`	yes	When (RFC 3339).
`revertTo`	`ModeView`	yes	Mode restored when the switch is not confirmed.

PermissionView

A permission.

Name	Type	Required	Description
`entityId`	`string`	yes	Entity id.
`id`	`string`	yes	Permission id.
`principal`	`PrincipalView`	yes	Principal.
`propagate`	`boolean`	yes	Propagate to descendants.
`roleId`	`string`	yes	Role id.

PlanHoursView

Hours on one plan.

Name	Type	Required	Description
`hours`	`number` (double)	yes	Hours in the month.
`plan`	`string`	yes	Plan.
`planName`	`string`	yes	Its name.

PlanView

A VM plan.

Name	Type	Required	Description
`allowedImages`	array of `string`		Images that may be used (empty: every catalogue image).
`bandwidthMbit`	`integer` (int32) or `null`		Bandwidth cap (Mbit/s).
`description`	`string`		Description.
`diskGib`	`integer` (int64)	yes	Disk (GiB).
`diskType`	`string`		`thin` or `thick`.
`id`	`string`		`vmplan-N` (ignored in requests).
`ipv6`	`boolean`		An IPv6 /64.
`memoryMib`	`integer` (int64)	yes	Memory (MiB).
`name`	`string`	yes	Unique name.
`orderable`	`boolean`		Orderable by tenants.
`publicIpv4`	`integer` (int32)		Public IPv4 addresses included.
`trafficAction`	`string`		`notify` or `throttle` at 100 % of the monthly traffic.
`trafficGibMonth`	`integer` (int64)		Traffic per month (GiB, 0 = unmetered).
`vcpus`	`integer` (int32)	yes	vCPUs.

PolicyBody

Create or replace a policy. rules on PUT replaces the rules (a rule with the id of an existing one keeps its number); absent, the rules stay.

Name	Type	Required	Description
`appliedTo`	array of `string`		Groups the policy applies to (empty: every vNIC; a tenant's: its own vNICs).
`category`	`CategoryView`	yes	Category; tenants may use `environment` and `application` only.
`description`	`string`		Description.
`enabled`	`boolean`		Enabled (default true).
`name`	`string`	yes	Name (unique in its scope; `sys:` is reserved).
`rules`	array of `RuleBody` or `null`		Rules in order.
`sequence`	`integer` (int32) or `null`		Order inside the category (lower first). Default: after the scope's last policy.
`stateful`	`boolean`		Replies are allowed automatically (default true).

PolicyInput

The settable part of a traffic policy.

Name	Type	Description
`action`	`TrafficAction`	Action at 100 %.
`anchorDay`	`integer` (int32) or `null`	Anchor day (1 to 28); absent: the tenant's or the 1st.
`monthlyLimitBytes`	`integer` (int64) or `null`	Bytes per period; absent: no limit.
`tenant`	`string` or `null`	Tenant (events).
`throttleKbps`	`integer` (int64) or `null`	Throttle rate (kbit/s); absent: the site default.

PolicyStatsView

Counters of a policy's rules.

Name	Type	Required	Description
`policy`	`string`	yes	Policy id.
`rules`	array of `RuleStatsView`	yes	Per rule, in policy order.

PolicyView

A policy with its rules.

Name	Type	Required	Description
`appliedTo`	array of `string`	yes	Applied-to groups.
`builtin`	`boolean`	yes	Built in (read-only).
`category`	`CategoryView`	yes	Category.
`description`	`string`		Description.
`enabled`	`boolean`	yes	Enabled.
`expiresAt`	`string` or `null`		End of an emergency bypass (RFC 3339).
`fwVersion`	`integer` (int64) or `null`		Store version of this write.
`id`	`string`	yes	`fwpolicy-N`.
`name`	`string`	yes	Name.
`notes`	array of `IssueView`		Validation notes of this write (rules that can match nothing).
`pendingHosts`	array of `string`		Hosts that had not applied the change when `?wait=realized` timed out.
`rules`	array of `RuleView`	yes	Rules in order.
`sequence`	`integer` (int32)	yes	Sequence.
`stateful`	`boolean`	yes	Stateful.
`tenant`	`string` or `null`		Owner (`null`: provider).
`version`	`integer` (int64)	yes	Record version.

PoolIpv6View

The IPv6 side of a pool.

Name	Type	Required	Description
`gateway`	`string` or `null`		Default gateway of the guests (the router's link-local or on-link address).
`prefix`	`string`	yes	Prefix (host bits zero), e.g. `2001:db8:100::`.
`prefixLen`	`integer` (int32)	yes	Prefix length (32 to 127, shorter than `serverPrefixLen`); block 0 stays with the router.
`reserved`	array of `string`		Addresses inside the prefix used by others (the host's own address): their blocks are never handed out.
`serverPrefixLen`	`integer` (int32) or `null`		Length of every server's block, 64 to 128 (default 64; 112 for a /112 per VPS from a host's single /64).

PoolLease

A primary address from an IP pool: it replaces the range lease of the NIC and carries the pool's subnet, gateway and DNS servers.

Name	Type	Required	Description
`address`	`string`	yes	The address.
`dns_servers`	array of `string`		The pool's DNS servers; empty: the network's.
`gateway`	`string` or `null`		The pool's gateway.
`prefix_len`	`integer` (int32)	yes	Prefix length of the pool's subnet.

PoolUsage

Counts of a pool.

Name	Type	Required	Description
`allocated`	`integer` (int64)	yes	Allocated.
`capacity`	`integer` (int64)	yes	Addresses the pool can hand out (ranges minus gateway, reserved, network and broadcast addresses).
`free`	`integer` (int64)	yes	Free now.
`ipv6Allocated`	`integer` (int64)	yes	/64 prefixes allocated.
`ipv6Capacity`	`integer` (int64)	yes	/64 prefixes the pool can hand out (0 without IPv6).
`ipv6Free`	`integer` (int64)	yes	IPv6 blocks free now (0 without IPv6).
`ipv6Quarantined`	`integer` (int64)	yes	IPv6 blocks in quarantine (not yet free again).
`quarantined`	`integer` (int64)	yes	In quarantine (not yet free again).

PortgroupIpv6

IPv6 settings of a distributed port group.

Name	Type	Required	Description
`dhcp`	`boolean`		Answer DHCPv6 with the port's address (router advertisements with the managed flag come from the network's router).
`prefix`	`string`	yes	The /64 prefix (`2001:db8:10::/64`).

PortgroupIpv6Request

IPv6 settings of a port group.

Name	Type	Required	Description
`dhcp`	`boolean` or `null`		Answer DHCPv6 (default true).
`prefix`	`string`	yes	The /64 prefix (`2001:db8:10::/64`).

PostEventRequest

Inject a typed event into the native event log (PostEvent).

Name	Type	Required	Description
`attributes`	`object`		Extra attributes.
`chainId`	`string` or `null`		Correlation id; a new id is allocated when omitted.
`entityId`	`string` or `null`		Optional target inventory object id.
`eventType`	`string`	yes	Event type in vSphere style (`GeneralUserEvent`, `EventEx`, …).
`message`	`string` or `null`		Free-form message text (stored as message arg `msg` when set).
`messageId`	`string` or `null`		Localisable message key; defaults to `event.user` when `message` is set, else `event.posted`.
`severity`	`SeverityView` or `null`

PowerRequest

Optional idempotency key for power operations.

Name	Type	Required	Description
`idempotencyKey`	`string` or `null`		Idempotency key.

PowerResultView

TaskView.result of VM power operations (powerOn / powerOff / reset / suspend).

Name	Type	Required	Description
`generation`	`integer` (int64)	yes	Desired-state generation the agent must converge to.
`powerState`	`string`	yes	Desired power state after the operation (`powered_on`, `powered_off`, `suspended`, `paused`).

PowerState

VM power state as the control plane records it (desired and observed).

PoweredOn, PoweredOff and Suspended are the vSphere-compatible values; Paused is the Compute team's paused (vCPUs stopped, memory live), which tools see as powered on. The agent's full lifecycle set (starting, stopping, migrating, ...) is kept separately in [VmRuntime::lifecycle].

Values: "powered_off", "powered_on", "suspended", "paused"

PrincipalView

A principal.

Name	Type	Required	Description
`name`	`string`	yes	Name.
`type`	`string`	yes	`user` or `group`.

PrivilegeView

A catalogue privilege.

Name	Type	Required	Description
`description`	`string`	yes	Description.
`id`	`string`	yes	Id.

ProfileBody

A default profile.

Name	Type	Required	Description
`baseline`	`string` or `null`		Baseline policy (a provider Application policy evaluated after every tenant rule).
`inbound`	`DefaultActionView`	yes	Default for traffic arriving at the vNIC.
`name`	`string`	yes	Name.
`outbound`	`DefaultActionView`	yes	Default for traffic leaving the vNIC.
`selectable`	`boolean`		Tenants may choose it.

ProfileView

A profile.

Type: ProfileBody, object

ProposalView

A proposal from a monitor report.

Name	Type	Required	Description
`rules`	array of `RuleBody`	yes	Allow rules for the other inbound TCP and UDP ports seen.
`template`	`string` or `null`		A template whose ports were all seen (`web`, `mail-server`).

ProtectionView

Protection of a vNIC.

Name	Type	Required	Description
`reason`	`string` or `null`		Why a vNIC is unprotected (Linux bridge, port security off, not on a host bridge).
`state`	`string`	yes	`enforced`, `monitor`, `off` or `unprotected`.

PtrBody

Set a PTR name.

Name	Type	Required	Description
`ptr`	`string` or `null`		Host name; `null` or empty removes the record.

PtrRejectBody

Body of POST .../ptr/rejected.

Name	Type	Required	Description
`reason`	`string`	yes	Why (shown to the tenant).

PtrStatus

State of a PTR name in reverse DNS.

Values: "applied", "requested", "rejected", "to_remove"