api

type Artifact struct {
	ArtifactPost

	UUID uuid.UUID `json:"uuid" yaml:"uuid"`

	Files []string `json:"files" yaml:"files"`
}

type ArtifactPost struct {
	Type ArtifactType `json:"type" yaml:"type"`

	Properties ArtifactProperties `json:"properties" yaml:"properties"`
}

type ArtifactProperties struct {
	// Description of the artifact.
	Description string `json:"description,omitempty" yaml:"description,omitempty"`

	// OS name that the artifact relates to.
	OS OSType `json:"os,omitempty" yaml:"os,omitempty"`

	// Architectures used to match VMs to an artifact.
	Architectures []string `json:"architectures,omitempty" yaml:"architectures,omitempty"`

	// Versions used to match VMs to an artifact.
	Versions []string `json:"versions,omitempty" yaml:"versions,omitempty"`

	// Source type that the artifact relates to.
	SourceType SourceType `json:"source_type,omitempty" yaml:"source_type,omitempty"`
}

type ArtifactType string

type Batch struct {
	BatchPut

	// The status of this batch
	// Example: BATCHSTATUS_DEFINED
	Status BatchStatusType `json:"status" yaml:"status"`

	// A free-form string to provide additional information about the status
	// Example: "4 of 5 instances migrated"
	StatusMessage string `json:"status_message" yaml:"status_message"`
}

type BatchConstraint struct {
	// Name of the constraint.
	Name string `json:"name" yaml:"name"`

	// Description of the constraint.
	Description string `json:"description" yaml:"description"`

	// Expression used to select instances for the constraint.
	IncludeExpression string `json:"include_expression" yaml:"include_expression"`

	// Maximum amount of matched instances that can concurrently migrate, before moving to the next migration window.
	MaxConcurrentInstances int `json:"max_concurrent_instances" yaml:"max_concurrent_instances"`

	// Minimum amount of time required for an instance to boot after initial disk import. Migration window duration must be at least this much.
	MinInstanceBootTime string `json:"min_instance_boot_time" yaml:"min_instance_boot_time"`
}

type BatchPut struct {
	// A human-friendly name for this batch
	// Example: MyBatch
	Name string `json:"name" yaml:"name"`

	// The destination target name to be used by all instances in this batch
	// Example: Mytarget
	DefaultTarget string `json:"default_target" yaml:"default_target"`

	// The target project to use
	// Example: default
	DefaultTargetProject string `json:"default_target_project" yaml:"default_target_project"`

	// The Incus storage pool that this batch should use for creating VMs and mounting ISO images
	// Example: local
	DefaultStoragePool string `json:"default_storage_pool" yaml:"default_storage_pool"`

	// Whether to re-run scriptlets if a migration restarts
	RerunScriptlets bool `json:"rerun_scriptlets" yaml:"rerun_scriptlets"`

	// The placement scriptlet used to determine the target for queued instances.
	// Example: starlark scriptlet
	PlacementScriptlet string `json:"placement_scriptlet" yaml:"placement_scriptlet"`

	// A Expression used to select instances to add to this batch
	// Language reference: https://expr-lang.org/docs/language-definition
	// Example: GetInventoryPath() matches "^foobar/.*"
	IncludeExpression string `json:"include_expression" yaml:"include_expression"`

	// PostMigrationRetries is the maximum number of times post-migration steps will be retried upon errors.
	// Example: 5
	PostMigrationRetries int `json:"post_migration_retries" yaml:"post_migration_retries"`

	// Set of migration window timings.
	MigrationWindows []MigrationWindow `json:"migration_windows" yaml:"migration_windows"`

	// Set of constraints to apply to the batch.
	Constraints []BatchConstraint `json:"constraints" yaml:"constraints"`

	// Time in UTC when the batch was started.
	StartDate time.Time `json:"start_date" yaml:"start_date"`

	// Overrides to allow migrating instances that are otherwise restricted.
	RestrictionOverrides InstanceRestrictionOverride `json:"instance_restriction_overrides" yaml:"instance_restriction_overrides"`
}

type BatchStatusType string

type ExternalConnectivityStatus string

type IncusProperties struct {
	// Hostname or IP address of the target endpoint
	// Example: https://incus.local:6443
	Endpoint string `json:"endpoint" yaml:"endpoint"`

	// Store the expected target's TLS certificate, in raw bytes. Useful in situations when TLS certificate validation fails, such as when using self-signed certificates.
	ServerCertificate []byte `json:"trusted_server_certificate,omitempty" yaml:"trusted_server_certificate,omitempty"`

	// If set and the fingerprint matches that of the ServerCertificate, enables use of that certificate when performing TLS handshake.
	// Example: b51b3046a03164a2ca279222744b12fe0878a8c12311c88fad427f4e03eca42d
	TrustedServerCertificateFingerprint string `json:"trusted_server_certificate_fingerprint,omitempty" yaml:"trusted_server_certificate_fingerprint,omitempty"`

	// base64-encoded TLS client key for authentication
	TLSClientKey string `json:"tls_client_key,omitempty" yaml:"tls_client_key,omitempty"`

	// base64-encoded TLS client certificate for authentication
	TLSClientCert string `json:"tls_client_cert,omitempty" yaml:"tls_client_cert,omitempty"`

	// OpenID Connect tokens
	OIDCTokens *oidc.Tokens[*oidc.IDTokenClaims] `json:"oidc_tokens,omitempty" yaml:"oidc_tokens,omitempty"`

	// Connectivity status of this target
	ConnectivityStatus ExternalConnectivityStatus `json:"connectivity_status" yaml:"connectivity_status"`

	// Maximum number of concurrent imports that can occur
	// Example: 10
	ImportLimit int `json:"import_limit,omitempty" yaml:"import_limit,omitempty"`

	// Maximum number of concurrent instance creations that can occur
	// Example: 10
	CreateLimit int `json:"create_limit,omitempty" yaml:"create_limit,omitempty"`
}

type Instance struct {
	// The originating source name for this instance
	// Example: MySource
	Source string `json:"source" yaml:"source"`

	SourceType SourceType `json:"source_type" yaml:"source_type"`

	Properties InstanceProperties `json:"properties" yaml:"properties"`

	LastUpdateFromSource time.Time `json:"last_update_from_source" yaml:"last_update_from_source"`

	// Overrides, if any, for this instance
	// Example: {..., NumberCPUs: 16, ...}
	Overrides InstanceOverride `json:"overrides" yaml:"overrides"`
}

type InstanceOverride struct {
	// The last time this instance override was updated
	// Example: 2024-11-12 16:15:00 +0000 UTC
	LastUpdate time.Time `json:"last_update" yaml:"last_update"`

	// An optional comment about the override
	// Example: "Manually tweak number of CPUs"
	Comment string `json:"comment" yaml:"comment"`

	// If true, migration of this instance will be disabled.
	// Example: true
	DisableMigration bool `json:"disable_migration" yaml:"disable_migration"`

	// If true, restrictions that put the VM in a blocked state, preventing migration, will be ignored.
	// Example: true
	IgnoreRestrictions bool `json:"ignore_restrictions" yaml:"ignore_restrictions"`

	Properties InstancePropertiesConfigurable `json:"properties" yaml:"properties"`
}

type InstanceProperties struct {
	InstancePropertiesConfigurable

	UUID             uuid.UUID `json:"uuid"              yaml:"uuid"              expr:"uuid"`
	Name             string    `json:"name"              yaml:"name"              expr:"name"`
	Location         string    `json:"location"          yaml:"location"          expr:"location"`
	OS               string    `json:"os"                yaml:"os"                expr:"os"`
	OSVersion        string    `json:"os_version"        yaml:"os_version"        expr:"os_version"`
	SecureBoot       bool      `json:"secure_boot"       yaml:"secure_boot"       expr:"secure_boot"`
	LegacyBoot       bool      `json:"legacy_boot"       yaml:"legacy_boot"       expr:"legacy_boot"`
	TPM              bool      `json:"tpm"               yaml:"tpm"               expr:"tpm"`
	Running          bool      `json:"running"           yaml:"running"           expr:"running"`
	BackgroundImport bool      `json:"background_import" yaml:"background_import" expr:"background_import"`
	Architecture     string    `json:"architecture"      yaml:"architecture"      expr:"architecture"`

	NICs      []InstancePropertiesNIC      `json:"nics"      yaml:"nics"      expr:"nics"`
	Disks     []InstancePropertiesDisk     `json:"disks"     yaml:"disks"     expr:"disks"`
	Snapshots []InstancePropertiesSnapshot `json:"snapshots" yaml:"snapshots" expr:"snapshots"`
}

type InstancePropertiesConfigurable struct {
	Description string            `json:"description,omitempty" yaml:"description,omitempty" expr:"description"`
	CPUs        int64             `json:"cpus"                  yaml:"cpus"                  expr:"cpus"`
	Memory      int64             `json:"memory"                yaml:"memory"                expr:"memory"`
	Config      map[string]string `json:"config"                yaml:"config"                expr:"config"`
}

type InstancePropertiesDisk struct {
	Capacity  int64  `json:"capacity"  yaml:"capacity"  expr:"capacity"`
	Name      string `json:"name"      yaml:"name"      expr:"name"`
	Shared    bool   `json:"shared"    yaml:"shared"    expr:"shared"`
	Supported bool   `json:"supported" yaml:"supported" expr:"supported"`
}

type InstancePropertiesNIC struct {
	ID              string `json:"id"               yaml:"id"               expr:"id"`
	HardwareAddress string `json:"hardware_address" yaml:"hardware_address" expr:"hardware_address"`
	Network         string `json:"network"          yaml:"network"          expr:"network"`
	IPv4Address     string `json:"ipv4_address"     yaml:"ipv4_address"     expr:"ipv4_address"`
	IPv6Address     string `json:"ipv6_address"     yaml:"ipv6_address"     expr:"ipv6_address"`
}

type InstancePropertiesSnapshot struct {
	Name string `json:"name" yaml:"name" expr:"name"`
}

type InstanceRestrictionOverride struct {
	AllowUnknownOS          bool `json:"allow_unknown_os" yaml:"allow_unknown_os"`
	AllowNoIPv4             bool `json:"allow_no_ipv4" yaml:"allow_no_ipv4"`
	AllowNoBackgroundImport bool `json:"allow_no_background_import" yaml:"allow_no_background_import"`
}

type MigrationStatusType string

type MigrationWindow struct {
	// Start time for finalizing migrations after background import.
	Start time.Time `json:"start" yaml:"start"`

	// End time for finalizing migrations after background import.
	End time.Time `json:"end" yaml:"end"`

	// Lockout time after which the batch can no longer modify the target instance.
	Lockout time.Time `json:"lockout" yaml:"lockout"`
}

type Network struct {
	NetworkOverride

	// The identifier of the network
	// Example: network-23
	Identifier string `json:"identifier" yaml:"identifier"`

	// vCenter source for the network
	// Example: vcenter01
	Source string `json:"source" yaml:"source"`

	// Type of the network
	// Example: standard
	Type NetworkType `json:"type" yaml:"type"`

	// Full inventory location path of the network
	// Example: /vcenter01/network/net0
	Location string `json:"location" yaml:"location"`

	// Additional properties of the network.
	Properties json.RawMessage `json:"properties" yaml:"properties"`
}

type NetworkOverride struct {
	// Name of the network on the target.
	// Example: "vmware"
	Name string `json:"name" yaml:"name"`

	// Name of the parent bridge to use with a VLAN.
	// Example: br0
	BridgeName string `json:"bridge_name" yaml:"bridge_name"`

	// Name of the VLAN ID to use with a VLAN network.
	// Example: 1
	VlanID string `json:"vlan_id" yaml:"vlan_id"`
}

type NetworkType string

type OSType string

type Placement struct {
	// Name of the target this queue entry is migrating to
	TargetName string `json:"target_name,omitempty" yaml:"target_name,omitempty"`

	// Name of the target project this queue entry is migrating to
	TargetProject string `json:"target_project,omitempty" yaml:"target_project,omitempty"`

	// Storage pools keyed by attached disk name.
	StoragePools map[string]string `json:"storage_pools" yaml:"storage_pools"`

	// Networks keyed by attached network identifier.
	Networks map[string]string `json:"networks" yaml:"networks"`

	// VlanIDs keyed by attached network identifier.
	VlanIDs map[string]string `json:"vlan_ids" yaml:"vlan_ids"`
}

type QueueEntry struct {
	// UUID for the instance; populated from the source and used across all migration manager operations
	// Example: 26fa4eb7-8d4f-4bf8-9a6a-dd95d166dfad
	InstanceUUID uuid.UUID `json:"instance_uuid" yaml:"instance_uuid"`

	// The name of the instance
	// Example: UbuntuServer
	InstanceName string `json:"instance_name" yaml:"instance_name"`

	// The migration status of the instance
	// Example: MIGRATIONSTATUS_RUNNING
	MigrationStatus MigrationStatusType `json:"migration_status" yaml:"migration_status"`

	// A free-form string to provide additional information about the migration status
	// Example: "Migration 25% complete"
	MigrationStatusMessage string `json:"migration_status_message" yaml:"migration_status_message"`

	// A human-friendly name for the batch
	// Example: MyBatch
	BatchName string `json:"batch_name" yaml:"batch_name"`

	// Time in UTC that the queue entry received a response from the migration worker
	LastWorkerResponse time.Time

	// The window that this queue entry will perform the final import steps
	MigrationWindow MigrationWindow `json:"migration_window" yaml:"migration_window"`

	// Configuration for which target the instance will be placed on.
	Placement Placement `json:"placement" yaml:"placement"`
}

type ServerPut struct {
	// Server configuration map (refer to doc/server.md)
	// Example: {"core.https_address": ":6443"}
	Config map[string]string `json:"config" yaml:"config"`
}

type ServerUntrusted struct {
	ServerPut `yaml:",inline"`

	// Support status of the current API (one of "devel", "stable" or "deprecated")
	// Read only: true
	// Example: stable
	APIStatus string `json:"api_status" yaml:"api_status"`

	// API version number
	// Read only: true
	// Example: 1.0
	APIVersion string `json:"api_version" yaml:"api_version"`

	// Whether the client is trusted (one of "trusted" or "untrusted")
	// Read only: true
	// Example: untrusted
	Auth string `json:"auth" yaml:"auth"`

	// List of supported authentication methods
	// Read only: true
	// Example: ["tls"]
	//
	// API extension: macaroon_authentication
	AuthMethods []string `json:"auth_methods" yaml:"auth_methods"`
}

type Source struct {
	SourcePut
	// SourceType defines the type of the source
	SourceType SourceType `json:"source_type" yaml:"source_type"`
}

type SourcePut struct {
	// A human-friendly name for this source
	// Example: MySource
	Name string `json:"name" yaml:"name"`

	// Properties contains source type specific properties
	Properties json.RawMessage `json:"properties" yaml:"properties"`
}

type SourceType string

type SystemCertificatePost struct {
	// The new certificate (X509 PEM encoded) for the system (server certificate).
	// Example: X509 PEM certificate
	Cert string `json:"certificate"   yaml:"certificate"`

	// The new certificate key (X509 PEM encoded) for the system (server key).
	// Example: X509 PEM certificate key
	Key string `json:"key,omitempty" yaml:"key,omitempty"`

	// The new certificate CA (X509 PEM encoded) for the system (server CA).
	// Example: X509 PEM certificate CA
	CA string `json:"ca" yaml:"ca"`
}

type SystemConfig struct {
	Network  SystemNetwork  `json:"network"  yaml:"network"`
	Security SystemSecurity `json:"security" yaml:"security"`
}

type SystemNetwork struct {
	// Address and port to bind the REST API to.
	Address string `json:"rest_server_address" yaml:"rest_server_address"`

	// URL used by Migration Manager workers to connect to the Migration Manager daemon.
	WorkerEndpoint string `json:"worker_endpoint"     yaml:"worker_endpoint"`
}

type SystemSecurity struct {
	// An array of SHA256 certificate fingerprints that belong to trusted TLS clients.
	TrustedTLSClientCertFingerprints []string `json:"trusted_tls_client_cert_fingerprints" yaml:"trusted_tls_client_cert_fingerprints"`

	OIDC    SystemSecurityOIDC    `json:"oidc"    yaml:"oidc"`
	OpenFGA SystemSecurityOpenFGA `json:"openfga" yaml:"openfga"`
}

type SystemSecurityOIDC struct {
	// OIDC Issuer.
	Issuer string `json:"issuer"    yaml:"issuer"`

	// Client ID used for communication with the OIDC issuer.
	ClientID string `json:"client_id" yaml:"client_id"`

	// Scopes to be requested.
	Scope string `json:"scopes"    yaml:"scopes"`

	// Audience the OIDC tokens should be verified against.
	Audience string `json:"audience"  yaml:"audience"`

	// Claim which should be used to identify the user or subject.
	Claim string `json:"claim"     yaml:"claim"`
}

type SystemSecurityOpenFGA struct {
	// API token used for communication with the OpenFGA system.
	APIToken string `json:"api_token" yaml:"api_token"`

	// URL of the OpenFGA API.
	APIURL string `json:"api_url"   yaml:"api_url"`

	// ID of the OpenFGA store.
	StoreID string `json:"store_id"  yaml:"store_id"`
}

type Target struct {
	TargetPut

	// TargetType defines the type of the target
	TargetType TargetType `json:"target_type" yaml:"target_type"`
}

type TargetPut struct {
	// A human-friendly name for this target
	// Example: MyTarget
	Name string `json:"name" yaml:"name"`

	// Properties contains target type specific properties
	Properties json.RawMessage `json:"properties" yaml:"properties"`
}

type TargetType string

type VMwareProperties struct {
	// Hostname or IP address of the source endpoint
	// Example: vsphere.local
	Endpoint string `json:"endpoint" yaml:"endpoint"`

	// Store the expected source's TLS certificate, in raw bytes. Useful in situations when TLS certificate validation fails, such as when using self-signed certificates.
	ServerCertificate []byte `json:"trusted_server_certificate,omitempty" yaml:"trusted_server_certificate,omitempty"`

	// If set and the fingerprint matches that of the ServerCertificate, enables use of that certificate when performing TLS handshake.
	// Example: b51b3046a03164a2ca279222744b12fe0878a8c12311c88fad427f4e03eca42d
	TrustedServerCertificateFingerprint string `json:"trusted_server_certificate_fingerprint,omitempty" yaml:"trusted_server_certificate_fingerprint,omitempty"`

	// Username to authenticate against the endpoint
	// Example: admin
	Username string `json:"username" yaml:"username"`

	// Password to authenticate against the endpoint
	// Example: password
	Password string `json:"password" yaml:"password"`

	// Connectivity status of this source
	ConnectivityStatus ExternalConnectivityStatus `json:"connectivity_status" yaml:"connectivity_status"`

	// Maximum number of concurrent imports that can occur
	// Example: 10
	ImportLimit int `json:"import_limit,omitempty" yaml:"import_limit,omitempty"`
}

type Warning struct {
	WarningPut
	UUID          uuid.UUID    `json:"uuid"             yaml:"uuid"`
	Scope         WarningScope `json:"scope"            yaml:"scope"`
	Type          WarningType  `json:"type"             yaml:"type"`
	FirstSeenDate time.Time    `json:"first_seen_date"  yaml:"first_seen_date"`
	LastSeenDate  time.Time    `json:"last_seen_date"   yaml:"last_seen_date"`
	UpdatedDate   time.Time    `json:"updated_date"     yaml:"updated_date"`
	Messages      []string     `json:"messages"         yaml:"messages"`
	Count         int          `json:"count"            yaml:"count"`
}

type WarningPut struct {
	Status WarningStatus `json:"status" yaml:"status"`
}

type WarningScope struct {
	Scope      string `json:"scope"        yaml:"scope"`
	EntityType string `json:"entity_type"  yaml:"entity_type"`
	Entity     string `json:"entity"       yaml:"entity"`
}

type WarningStatus string

type WarningType string

type WorkerCommand struct {
	// The command for the worker to execute
	// Example: WORKERCOMMAND_IMPORT_DISKS
	Command WorkerCommandType `json:"command" yaml:"command"`

	// Internal path to the instance
	// Example: /SHF/vm/Migration Tests/DebianTest
	Location string `json:"location" yaml:"location"`

	// SourceType declares the type of the worker and is used as a hint to
	// correctly process the details provided in Source.
	SourceType SourceType `json:"sourceType" yaml:"sourceType"`

	// Source for the worker to fetch VM metadata and/or disk from.
	Source json.RawMessage `json:"source" yaml:"source"`

	// The name of the operating system
	// Example: Ubuntu
	OS string `json:"os" yaml:"os"`

	// The version of the operating system
	// Example: 24.04
	OSVersion string `json:"os_version" yaml:"os_version"`

	// Operating system type
	// Example: linux
	OSType OSType `json:"os_type" yaml:"os_type"`

	// Architecture of the instance
	// Example: x86_64
	Architecture string `json:"architecture" yaml:"architecture"`
}

type WorkerCommandType int

type WorkerResponse struct {
	// The status of the command the work is/was executing.
	// Example: WORKERRESPONSE_RUNNING
	Status WorkerResponseType `json:"status" yaml:"status"`

	// A free-form string to provide additional information about the command status
	// Example: "Migration 25% complete"
	StatusMessage string `json:"status_message" yaml:"status_message"`
}

type WorkerResponseType int