API schemas: N

NbdExportView

OpenAPI stand-in for NbdExport.

Name	Type	Required	Description
`exportName`	`string`	yes	NBD export name.
`fleecing`	`boolean`	yes	Whether a fleecing image protects the running VM.
`metaContexts`	array of `string`	yes	Meta contexts the server offers.
`readOnly`	`boolean`	yes	Exports are read-only for backup (writable for restore).
`size`	`integer` (int64)	yes	Size of the export in bytes.
`transport`	`NbdTransportView`	yes	Where to connect.

OpenAPI stand-in for NbdTransport (tagged on kind).

One of: object, object

A standard (host-scoped) network.

Name	Type	Required	Description
`backing`	`NetworkBacking` or `null`
`hosts`	array of `string`		Hosts offering this network.
`name`	`string`	yes	Display name.
`vlan_id`	`integer` (int32)		VLAN id, 0 for untagged.

How VMs on a network reach the host.

The network the guest was verified on.

Name	Type	Required	Description
`bridge`	`string`	yes	Bridge on the hosts.
`id`	`string`	yes	Network record id.
`name`	`string`	yes	Network name.
`quarantine`	`boolean`	yes	Always true for a verified restore.

One host-bridge network's VLAN/MTU check.

Name	Type	Required	Description
`bridge`	`string`	yes	Bridge name.
`healthy`	`boolean`	yes	True when this check is healthy.
`mtuExpected`	`integer` (int32) or `null`		Expected MTU when declared.
`mtuObserved`	`integer` (int32) or `null`		Observed MTU when known.
`mtuStatus`	`string`	yes	MTU status (`ok`, `mismatch`, `skipped`, `bridgeMissing`, `unknown`, `unchecked`).
`name`	`string` or `null`		Display name.
`networkId`	`string` or `null`		Inventory network id.
`vlanExpected`	`integer` (int32)	yes	Expected VLAN id.
`vlanObserved`	array of `NetworkHealthPortVlanView`		Observed mismatched ports (VLAN mismatch only).
`vlanStatus`	`string`	yes	VLAN status (`ok`, `mismatch`, `noPorts`, `bridgeMissing`, `unchecked`).

Observed VLAN on a mismatched port.

Name	Type	Required	Description
`port`	`string`	yes	Port / tap name.
`tag`	`integer` (int32) or `null`		OVS tag when present.

Native VLAN/MTU health response.

Name	Type	Required	Description
`checks`	array of `NetworkHealthCheckView`	yes	Per host-bridge network results.
`healthy`	`boolean`	yes	True when every check is healthy (or there is nothing to check).
`source`	`string`	yes	`agent` when the host agent answered; `none` when detached.

One physical NIC's discovered neighbour summary (PhysicalNicHintInfo).

Name	Type	Required	Description
`cdp`	`CdpHintView` or `null`
`device`	`string`	yes	Host interface name (`eno1`, OVS port name, …).
`lldp`	`LldpHintView` or `null`

Native QueryNetworkHint response (agent scrape + optional device filter).

Name	Type	Required	Description
`hints`	array of `NetworkHintView`	yes	Per-device hints (only devices with at least one neighbour protocol).
`source`	`string`	yes	Collector that produced the scrape (`ovs`, `lldpd`, or `none`).

One file on a native NFC lease.

Name	Type	Required	Description
`bytesReceived`	`integer` (int64)		Import: bytes the controller has received of this file so far, also while the upload runs (another browser tab or a reload can show the progress).
`capacityBytes`	`integer` (int64)	yes	Virtual capacity in bytes.
`disk`	`boolean`	yes	Disk (converted) vs ISO/image.
`key`	`string`	yes	Device / import key.
`name`	`string`	yes	Basename (`disk-0.vmdk`).
`requireUpload`	`boolean`	yes	Import: must be uploaded before Complete.
`size`	`integer` (int64)	yes	Known size (prepared download or received upload).
`url`	`string`	yes	Relative transfer URL (`/v1/nfc-leases/{id}/files/{name}`). A browser uploads with `PUT` and `Authorization: Bearer <access token>`, the body is the file as it is (`application/octet-stream`); no CSRF header is needed. The controller converts VMDK (sparse or streamOptimized), qcow2 and raw disks at `complete`.

Progress update (POST /v1/nfc-leases/{id}/progress).

Name	Type	Required	Description
`percent`	`integer` (int32)	yes	Percent complete (0 to 100).

Native HttpNfcLease view (GET /v1/nfc-leases/{id}, ExportVm / ImportVApp).

Name	Type	Required	Description
`entityId`	`string` or `null`		Imported VM id (import) or exported VM id (export).
`error`	`string` or `null`		Error message when `state` is `error`.
`expiresAt`	`string`		When the lease is aborted unless it is used before (RFC 3339): every upload chunk, progress report and read of the lease moves it 15 minutes ahead. An abandoned import is aborted and its virtual machine removed.
`files`	array of `NfcLeaseFileView`		Transferrable files.
`id`	`string`	yes	Lease id (`nfc-lease-` plus 32 random hex digits).
`initializeProgress`	`integer` (int32)	yes	Initialize progress (0 to 100).
`kind`	`string`	yes	`import` or `export`.
`sourceVmId`	`string` or `null`		Source VM id on export.
`state`	`string`	yes	`initializing` / `ready` / `done` / `error`.
`totalDiskCapacityKb`	`integer` (int64)	yes	Sum of disk capacities in KiB.
`transferProgress`	`integer` (int32)	yes	Transfer progress (0 to 100).

An IPv6 prefix of a NIC (a /64 per server).

Name	Type	Required	Description
`prefix`	`string`	yes	The prefix, host bits zero.
`prefix_len`	`integer` (int32)	yes	Its length.

Policy of one NIC on a host-bridge network (§11.2). A NIC with a policy always has port security: anti-spoofing is mandatory for tenant NICs.

Name	Type	Description
`extra_ipv4`	array of `string`	Extra addresses from IP pools (port security allows them; the guest configures them).
`ipv4`	`PoolLease` or `null`
`ipv6`	array of `NicIpv6`	IPv6 prefixes from IP pools.
`rate_limit_kbps`	`integer` (int64) or `null`	Traffic throttle in kbit/s, both directions (ingress policing and `linux-htb`).
`smtp_block_v4`	`boolean`	Outgoing SMTP (TCP 25) over IPv4 is dropped (pool `smtp_ipv4`, per-VM unblock).
`smtp_block_v6`	`boolean`	Outgoing SMTP (TCP 25) over IPv6 is dropped (pool `smtp_ipv6`, default blocked).

Body of PUT /v1/vms/{id}/nics/{key}/firewall.

Name	Type	Required	Description
`profile`	`string` or `null`		Profile id; `null`: the profile of the NIC kind.