PHphala
CVMs
cvms-network-config

Set port mappings

Changed on

Bulk-replace all port mappings for this CVM. Admins with two-factor authentication enabled may specify host_port within the node's managed range; other callers cannot pin ports. Omitted or null host_port keeps an existing allocation or randomly allocates a new one. User-NIC port changes require restart confirmation; bridge-NIC rules apply live.

put/api/v1/cvms/{cvm_id}/ports

Request

Path parameters

cvm_idstring required

Request body

confirm_restartboolean

Explicit consent to restart the CVM if the change requires it. source_cidrs-only changes never trigger a restart.

Response

Updated port mappings

idstring hashid required

A hashed identifier that maps to an internal database ID

host_portinteger required
vm_portinteger required
nic_indexinteger
protocolstring required
host_addressstring required
source_cidrsstring[]
descriptionstring nullable
public_hoststring nullable

Node-level public DNS/IP; None when the node is not publicly reachable.

forwarding_backendstring

"vmm_hostfwd" when QEMU forwards the port on a user-mode NIC, "netd_forward" when teescope-netd DNATs it to a bridge-mode NIC, "unknown" when the node has not reported its default network mode.

restart_requiredboolean

Whether adding or removing this rule needs a CVM restart. Always false for netd_forward rules: netd installs them on the live host.

guest_ipstring nullable

Guest address a netd_forward rule currently resolves to, read back from the node. None for vmm_hostfwd rules and when the node was not reachable. Empty string means the NIC's DHCP reservation is gone and the rule is inert.

Example response

[
  {
    "id": "pm_0123abcd"
  }
]

Changes

  • c71a8dc90391Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status