Compare commits
8
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
5059df6b25 | ||
|
|
a37dc8d632 | ||
|
|
cb274156a4 | ||
|
|
a16ca77156 | ||
|
|
fcf72b6dad | ||
|
|
2cc93885b4 | ||
|
|
97cab9754b | ||
|
|
7d18c12579 |
@@ -16,6 +16,7 @@ from napalm_device_types._ucd_metrics import IF_SKIP_DEFAULT, collect_ucd_metric
|
||||
from napalm_device_types.models import (
|
||||
HealthMetricsDict,
|
||||
NICConfigDict,
|
||||
NetworkTargetDict,
|
||||
PackageDict,
|
||||
SnapshotDict,
|
||||
StorageVolumeDict,
|
||||
@@ -547,25 +548,34 @@ class HypervisorDriver(DeviceTypeDriver):
|
||||
self,
|
||||
name: str,
|
||||
*,
|
||||
template: str,
|
||||
image_url: str,
|
||||
cpu: int,
|
||||
memory: int,
|
||||
nics: List[NICConfigDict],
|
||||
cloud_init_config: Dict[str, Any],
|
||||
image_checksum: str | None = None,
|
||||
ssh_public_keys: List[str] | None = None,
|
||||
disk_resize_gb: int | None = None,
|
||||
download_timeout: int = 300,
|
||||
timeout: int = 180,
|
||||
) -> VMProvisionResultDict:
|
||||
"""
|
||||
Create a new virtual machine from a Cloud-Init template.
|
||||
Create a new virtual machine from a cloud image via Cloud-Init.
|
||||
|
||||
Clones a pre-existing VM template, configures virtual network interfaces,
|
||||
and injects Cloud-Init configuration via a storage snippet or similar
|
||||
mechanism. The resulting VM is left in a running state.
|
||||
Downloads the cloud image (qcow2/raw) directly on the hypervisor if not
|
||||
already cached there, creates a new VM shell, imports the image as its
|
||||
root disk, configures virtual network interfaces, and injects Cloud-Init
|
||||
configuration via a storage snippet or similar mechanism. The resulting
|
||||
VM is left in a running state.
|
||||
|
||||
Implementations should cache downloaded images by URL/filename on the
|
||||
hypervisor so repeated provisioning from the same image does not
|
||||
re-download it every time.
|
||||
|
||||
Args:
|
||||
name (string) - new VM display name
|
||||
template (string) - hypervisor-internal ID/name of the template VM to clone
|
||||
image_url (string) - URL of the cloud image to download and use as
|
||||
the VM's root disk (e.g. an official Debian/Ubuntu cloud image).
|
||||
cpu (int) - number of virtual CPUs to assign
|
||||
memory (int) - RAM to assign in megabytes
|
||||
nics (list[NICConfigDict]) - list of network interface configurations.
|
||||
@@ -574,20 +584,25 @@ class HypervisorDriver(DeviceTypeDriver):
|
||||
and dhcp flag.
|
||||
cloud_init_config (dict) - user-data dict (will be rendered to YAML).
|
||||
Should include hostname, bootstrap_token, runcmd, and any custom config.
|
||||
image_checksum (string | None) - expected checksum of the downloaded
|
||||
image (e.g. "sha256:<hex>"). If given, verified after download;
|
||||
mismatch raises RuntimeError. If None, no verification is performed.
|
||||
ssh_public_keys (list[str] | None) - SSH public keys to inject into guest.
|
||||
If None or empty, no SSH key injection is performed.
|
||||
disk_resize_gb (int | None) - resize root disk to this size in GB.
|
||||
If None, disk remains template size. Default None.
|
||||
timeout (int) - maximum seconds to wait for provisioning completion
|
||||
(clone, config, start). Default 180.
|
||||
If None, disk remains the downloaded image's native size. Default None.
|
||||
download_timeout (int) - maximum seconds to wait for the image download
|
||||
(skipped entirely if already cached on the hypervisor). Default 300.
|
||||
timeout (int) - maximum seconds to wait for the remaining provisioning
|
||||
steps (VM creation, disk import, config, start). Default 180.
|
||||
|
||||
Returns:
|
||||
VMProvisionResultDict - ``{"vmid": str, "name": str, "node": str}``
|
||||
vmid is the hypervisor-internal VM ID as a string (numeric for Proxmox).
|
||||
|
||||
Raises:
|
||||
RuntimeError - if provisioning fails (storage unavailable, invalid
|
||||
config, timeout, etc.)
|
||||
RuntimeError - if provisioning fails (download failure, checksum
|
||||
mismatch, storage unavailable, invalid config, timeout, etc.)
|
||||
"""
|
||||
raise NotImplementedError
|
||||
|
||||
@@ -655,3 +670,21 @@ class HypervisorDriver(DeviceTypeDriver):
|
||||
timeout is exceeded.
|
||||
"""
|
||||
raise NotImplementedError
|
||||
|
||||
def get_network_targets(self) -> List[NetworkTargetDict]:
|
||||
"""
|
||||
List the network targets a new VM's NIC may attach to.
|
||||
|
||||
Returns only targets that are actually valid ``NICConfigDict.bridge``
|
||||
values — real bridges (Linux or OVS) and SDN network segments (vnets).
|
||||
Physical NICs, bonds, and other non-bridge interface types are excluded,
|
||||
since VMs cannot attach directly to them on any hypervisor this interface
|
||||
supports.
|
||||
|
||||
Returns:
|
||||
List[NetworkTargetDict] - each entry's ``vlan_aware`` flag tells the
|
||||
caller whether a ``NICConfigDict.vlan_tag`` may additionally be set
|
||||
for a NIC using that target (see ``NetworkTargetDict`` for the
|
||||
per-kind rules).
|
||||
"""
|
||||
raise NotImplementedError
|
||||
|
||||
@@ -730,3 +730,22 @@ class VMStatusDict(TypedDict):
|
||||
ip_address: NotRequired[str] # Management NIC IP (absent if VM has no IP or is stopped)
|
||||
hostname: NotRequired[str] # Hostname resolved from IP (if available)
|
||||
mac_address: NotRequired[str] # MAC of management NIC
|
||||
|
||||
|
||||
class NetworkTargetDict(TypedDict):
|
||||
"""A selectable network target for a new VM's NIC (``NICConfigDict.bridge``).
|
||||
|
||||
Distinguishes real bridges (Linux or OVS) from SDN network segments (vnets),
|
||||
and tells the caller whether a separate ``vlan_tag`` may be applied on top:
|
||||
- Linux bridge: vlan_aware reflects the bridge's own ``bridge_vlan_aware`` flag.
|
||||
- OVS bridge: always vlan_aware (OVS bridges tag per-port regardless of a
|
||||
dedicated "VLAN aware" setting).
|
||||
- SDN vnet: never vlan_aware — the VLAN is already fixed by the vnet's zone/tag,
|
||||
so a NIC attached to it must not also carry a ``vlan_tag``. That fixed VLAN
|
||||
is surfaced via ``fixed_vlan_tag`` instead, for display purposes.
|
||||
"""
|
||||
|
||||
name: str # Bridge or vnet name, usable directly as NICConfigDict.bridge
|
||||
kind: str # "bridge" or "vnet"
|
||||
vlan_aware: bool # True if a NICConfigDict.vlan_tag may be set on top of this target
|
||||
fixed_vlan_tag: NotRequired[int | None] # vnet only: the VLAN ID already baked into it
|
||||
|
||||
Reference in New Issue
Block a user