@vates/types 1.26.0 → 1.28.0

package/dist/common.d.mts

@@ -605,6 +605,8 @@ export type XapiPoolStats = Record<XoHost['id'], XapiHostStats | {
 }>;
 export type TrafficRuleProtocol = (typeof TRAFFIC_RULE_PROTOCOLS)[number];
 export declare const SDN_CONTROLLER_OF_RULES_KEY = "xo:sdn-controller:of-rules";
+export declare const SDN_CONTROLLER_OF_METHOD_KEY = "xo:sdn-controller:of-method";
+export declare const SDN_CONTROLLER_OF_FORMAT_KEY = "xo:sdn-controller:of-format";
 export declare const TRAFFIC_RULE_PROTOCOLS: readonly ["ARP", "ICMP", "IP", "TCP", "UDP"];
 export declare const TRAFFIC_RULE_PROTOCOLS_WITH_PORT: readonly TrafficRuleProtocol[];
 export type TrafficRuleTargetType = XoNetwork['type'] | XoVif['type'];

package/dist/common.mjs

@@ -452,5 +452,7 @@ export const SUPPORTED_VDI_FORMAT = {
     qcow2: 'qcow2',
 };
 export const SDN_CONTROLLER_OF_RULES_KEY = 'xo:sdn-controller:of-rules';
+export const SDN_CONTROLLER_OF_METHOD_KEY = 'xo:sdn-controller:of-method';
+export const SDN_CONTROLLER_OF_FORMAT_KEY = 'xo:sdn-controller:of-format';
 export const TRAFFIC_RULE_PROTOCOLS = ['ARP', 'ICMP', 'IP', 'TCP', 'UDP'];
 export const TRAFFIC_RULE_PROTOCOLS_WITH_PORT = ['TCP', 'UDP'];

package/dist/lib/xen-orchestra-xapi.d.mts

@@ -51,6 +51,14 @@ export interface EditVmProps {
     virtualizationMode?: 'pv' | 'hvm';
     xenStoreData?: Record<string, string | null>;
 }
+/** Properties accepted by {@link Xapi.editVif}. */
+export interface EditVifProps {
+    ipv4Allowed?: string[];
+    ipv6Allowed?: string[];
+    lockingMode?: VIF_LOCKING_MODE;
+    rateLimit?: number | null;
+    txChecksumming?: boolean;
+}
 export type XcpPatches = {
     changelog?: {
         author: string;
@@ -80,6 +88,21 @@ export type XsPatches = {
     uuid?: string;
 };
 export interface Xapi {
+    status: string;
+    pool?: {
+        uuid: string;
+    };
+    sessionId: string;
+    _auth: {
+        user: string;
+        password: string;
+    };
+    _url: {
+        protocol: string;
+        hostname: string;
+        hostnameRaw: string;
+        port?: string;
+    };
     call: <ReturnType>(...args: unknown[]) => Promise<ReturnType>;
     callAsync: <ReturnType>(...args: unknown[]) => Promise<ReturnType>;
     barrier<T extends XenApiRecord>(ref: T['$ref']): Promise<Extract<WrappedXenApiRecord, {
@@ -112,6 +135,9 @@ export interface Xapi {
     deleteVif(vifId: XoVif['id']): Promise<void>;
     disconnectVif(vifId: XoVif['id']): Promise<void>;
     exportVmOva(vmRef: XenApiVm['$ref']): Promise<PassThrough>;
+    emergencyShutdownHost(hostId: XoHost['id']): Promise<void>;
+    ejectHostFromPool(hostId: XoHost['id']): Promise<void>;
+    host_smartReboot(hostRef: XenApiHost['$ref'], bypassBlockedSuspend?: boolean, bypassCurrentVmCheck?: boolean): Promise<void>;
     migrateVm(vmId: XoVm['id'], hostXapi: Xapi, hostId: XoHost['id'], opts?: {
         force?: boolean;
         mapVdisSrs?: Record<XoVdi['id'], XoSr['id']>;
@@ -120,6 +146,7 @@ export interface Xapi {
         sr?: XoSr['id'];
         bypassAssert?: boolean;
     }): Promise<void>;
+    joinPool(masterAddress: string, masterUsername: string, masterPassword: string, force?: boolean): Promise<void>;
     listMissingPatches(host: XoHost['id']): Promise<XcpPatches[] | XsPatches[]>;
     pool_emergencyShutdown(): Promise<void>;
     resumeVm(id: XoVm['id']): Promise<void>;
@@ -140,6 +167,13 @@ export interface Xapi {
         vm: XenApiVmWrapped;
     }>;
     forgetSr(id: XoSr['id']): Promise<void>;
+    forgetHost(hostId: XoHost['id']): Promise<void>;
+    powerOnHost(hostId: XoHost['id']): Promise<void>;
+    rebootHost(hostId: XoHost['id'], force?: boolean): Promise<void>;
+    shutdownHost(hostId: XoHost['id'], opts?: {
+        force?: boolean;
+        bypassEvacuate?: boolean;
+    }): Promise<void>;
     SR_importVdi(ref: XenApiSr['$ref'], stream: Readable, opts?: {
         format?: SUPPORTED_VDI_FORMAT;
         name_description?: XoVdi['name_description'];
@@ -155,6 +189,7 @@ export interface Xapi {
     }): Promise<XenApiVdi['$ref']>;
     SR_reclaimSpace(ref: XenApiSr['$ref']): Promise<void>;
     editVm(id: XoVm['id'], props: EditVmProps, checkLimits?: (limits: Record<string, number>, vm: XenApiVmWrapped) => Promise<void>): Promise<void>;
+    editVif(id: XoVif['id'], props: EditVifProps): Promise<void>;
     startVm(id: XoVm['id'], opts?: {
         bypassMacAddressesCheck?: boolean;
         force?: boolean;
@@ -169,7 +204,7 @@ export interface Xapi {
     }): Promise<void>;
     VM_export(vmRef: XenApiVm['$ref'], opts?: {
         cancelToken?: unknown;
-        compress?: boolean;
+        compress?: boolean | 'zstd' | 'gzip';
         useSnapshot?: boolean;
     }): ReturnType<Xapi['getResource']>;
     VM_import(stream: Readable, srRef?: XenApiSr['$ref'], onVmCreation?: null | ((vm: XenApiVm) => unknown)): Promise<XenApiVm['$ref']>;

package/dist/xen-api.d.mts

@@ -115,6 +115,7 @@ export interface XenApiPool {
     ha_host_failures_to_tolerate: number;
     ha_overcommitted: boolean;
     ha_plan_exists_for: number;
+    ha_reboot_vm_on_internal_shutdown?: boolean;
     ha_statefiles: string[];
     health_check_config: Record<string, string>;
     igmp_snooping_enabled?: boolean;
@@ -483,7 +484,9 @@ export interface XenApiHost {
     uuid: string;
     virtual_hardware_platform_versions: number[];
 }
-export type XenApiHostWrapped = WrapperXenApi<XenApiHost, 'host', XenApiHostCallMethods>;
+export interface XenApiHostWrapped extends WrapperXenApi<XenApiHost, 'host', XenApiHostCallMethods> {
+    $restartAgent(): Promise<void>;
+}
 export interface XenApiHostCrashdump {
     $ref: Branded<'host_crashdump'>;
     host: XenApiHost['$ref'];

package/dist/xo-app.d.mts

@@ -1,19 +1,8 @@
 import { EventEmitter } from 'node:stream';
-import type { AnyXoBackupJob, AnyXoJob, AnyXoLog, XapiXoRecord, XoAuthenticationToken, XoBackupRepository, XoConfigBackupArchive, XoGroup, XoHost, XoPool, XoPoolBackupArchive, XoProxy, XoSchedule, XoServer, XoTask, XoUser, XoVm, XoVmBackupArchive } from './xo.mjs';
+import type { AnyXoJob, AnyXoLog, XapiXoRecord, XoAuthenticationToken, XoBackupRepository, XoConfigBackupArchive, XoGroup, XoHost, XoPool, XoPoolBackupArchive, XoProxy, XoSchedule, XoServer, XoTask, XoUser, XoVif, XoVm, XoVmBackupArchive } from './xo.mjs';
 import { VatesTask } from './lib/vates-task.mjs';
 import { Xapi, XapiHostStats, XapiPoolStats, XapiStatsGranularity, XapiVmStats, XenApiGpuGroupWrapped, XenApiHostWrapped, XenApiMessageWrapped, XenApiNetworkWrapped, XenApiPbdWrapped, XenApiPciWrapped, XenApiPgpuWrapped, XenApiPifWrapped, XenApiPoolWrapped, XenApiSmWrapped, XenApiSrWrapped, XenApiVbdWrapped, XenApiVdiWrapped, XenApiVgpuTypeWrapped, XenApiVgpuWrapped, XenApiVifWrapped, XenApiVmWrapped, XenApiVtpmWrapped, XoAclBasePrivilege, XoAclRole, XoGroupRole, XoUserRole } from './index.mjs';
-export type XapiConnection = Xapi & {
-    status: string;
-    pool?: {
-        uuid: string;
-    };
-    sessionId: string;
-    _url?: {
-        protocol: string;
-        hostname: string;
-        port?: string;
-    };
-};
+type FeatureCode = 'BACKUP.DELTA' | 'BACKUP.DELTA_REPLICATION' | 'BACKUP.FULL' | 'BACKUP.HEALTHCHECK' | 'BACKUP.METADATA' | 'BACKUP.MIRROR' | 'BACKUP.WITH_RAM' | 'BACKUP.SMART_BACKUP' | 'BACKUP.S3' | 'DOCKER' | 'EXPORT.XVA' | 'LIST_MISSING_PATCHES' | 'POOL_EMERGENCY_SHUTDOWN' | 'RBAC' | 'ROLLING_POOL_UPDATE' | 'ROLLING_POOL_REBOOT' | 'SMART_REBOOT' | 'WARM_MIGRATION' | 'PLUGIN.OPENMETRICS';
 type XapiRecordByXapiXoRecord = {
     gpuGroup: XenApiGpuGroupWrapped;
     host: XenApiHostWrapped;
@@ -124,6 +113,7 @@ export type XoApp = {
         user?: XoUser;
         permission?: XoUser['permission'] | 'none' | null;
     };
+    allocIpAddresses(vifId: XoVif['id'], addAddresses?: string[], removeAddresses?: string[]): Promise<void>;
     addAclV2GroupRole(groupId: XoGroup['id'], roleId: XoAclRole['id']): Promise<XoGroupRole>;
     addAclV2UserRole(userId: XoUser['id'], roleId: XoAclRole['id']): Promise<XoUserRole>;
     addUserToGroup: (userId: XoUser['id'], groupId: XoGroup['id']) => Promise<void>;
@@ -145,7 +135,8 @@ export type XoApp = {
         expiration: number;
         user: XoUser;
     }>;
-    checkFeatureAuthorization(featureCode: string): Promise<void>;
+    backupGuard(poolId: XoPool['id']): Promise<void>;
+    checkFeatureAuthorization(featureCode: FeatureCode): Promise<void>;
     connectXenServer(id: XoServer['id']): Promise<void>;
     createAclV2Privilege(privilege: Omit<XoAclBasePrivilege, 'id'>, options?: {
         force?: boolean;
@@ -167,6 +158,12 @@ export type XoApp = {
         expiresIn?: string | number;
         userId: XoUser['id'];
     }): Promise<XoAuthenticationToken>;
+    createRemote(params: {
+        name: string;
+        options?: string;
+        proxy?: XoProxy['id'];
+        url: string;
+    }): Promise<XoBackupRepository>;
     createUser(params: {
         name?: string;
         password?: string;
@@ -181,12 +178,14 @@ export type XoApp = {
     }): Promise<boolean>;
     deleteGroup(id: XoGroup['id']): Promise<void>;
     deleteUser(id: XoUser['id']): Promise<void>;
+    detachHostFromPool(hostId: XoHost['id']): Promise<void>;
     createGroup(params: {
         name: string;
         provider?: string;
         providerGroup?: string;
     }): Promise<XoGroup>;
     disconnectXenServer(id: XoServer['id']): Promise<void>;
+    findEnabledScheduleSequenceFromSchedule(id: XoSchedule['id']): Promise<XoSchedule | undefined>;
     getAclV2Privilege(id: XoAclBasePrivilege['id']): Promise<XoAclBasePrivilege>;
     getAclV2Privileges(): Promise<XoAclBasePrivilege[]>;
     getAclV2RolePrivileges(roleId: XoAclRole['id']): Promise<XoAclBasePrivilege[]>;
@@ -196,13 +195,14 @@ export type XoApp = {
     getAclV2UserPrivileges(userId: XoUser['id']): Promise<XoAclBasePrivilege[]>;
     getAllGroups(): Promise<XoGroup[]>;
     getAllProxies(): Promise<XoProxy[]>;
-    getAllJobs<T extends AnyXoBackupJob['type']>(type: T): Promise<Extract<AnyXoBackupJob, {
+    getAllJobs<T extends AnyXoJob['type']>(type: T): Promise<Extract<AnyXoJob, {
         type: T;
     }>[]>;
     getAllJobs(type?: string): Promise<AnyXoJob[]>;
     getProxy(id: XoProxy['id']): Promise<XoProxy>;
     getRemote(id: XoBackupRepository['id']): Promise<XoBackupRepository>;
     getAllRemotes(): Promise<XoBackupRepository[]>;
+    removeRemote(id: XoBackupRepository['id']): Promise<void>;
     getAllRemotesInfo(): Promise<Record<XoBackupRepository['id'], {
         size?: number;
         used?: number;
@@ -256,6 +256,9 @@ export type XoApp = {
         _forceRefresh?: boolean;
         vmId: XoVm['id'];
     }): Promise<Record<XoBackupRepository['id'], Record<XoVm['id'], XoVmBackupArchive[]>>>;
+    pingRemote(id: XoBackupRepository['id']): Promise<{
+        success: true;
+    }>;
     /** Allow to add a new server in the DB (XCP-ng/XenServer) */
     registerXenServer(body: Pick<XoServer, 'host' | 'httpProxy' | 'label' | 'username'> & {
         allowUnauthorized?: XoServer['allowUnauthorized'];
@@ -274,6 +277,16 @@ export type XoApp = {
     removeUserFromGroup(userId: XoUser['id'], id: XoGroup['id']): Promise<void>;
     runJob(job: AnyXoJob, schedule: XoSchedule): void;
     runWithApiContext: (user: XoUser | undefined, fn: () => void) => Promise<unknown>;
+    testRemote(id: XoBackupRepository['id']): Promise<{
+        success: true;
+        readRate: number;
+        writeRate: number;
+    } | {
+        success: false;
+        step: string;
+        file: string;
+        error: unknown;
+    }>;
     /** Remove a server from the DB (XCP-ng/XenServer) */
     unregisterXenServer(id: XoServer['id']): Promise<void>;
     updateUser(id: XoUser['id'], updates: {
@@ -297,7 +310,14 @@ export type XoApp = {
     updateGroup(id: XoGroup['id'], updates: {
         name?: string;
     }): void;
-    getAllXapis(): Record<string, XapiConnection>;
+    updateRemote(id: XoBackupRepository['id'], params: {
+        enabled?: boolean;
+        name?: string;
+        options?: string | null;
+        proxy?: XoProxy['id'] | null;
+        url?: string;
+    }): Promise<XoBackupRepository>;
+    getAllXapis(): Record<string, Xapi>;
     getObjects(opts?: {
         filter?: Record<string, unknown>;
         limit?: number;

package/dist/xo.d.mts

@@ -400,6 +400,7 @@ export type XoPool = BaseXapiXo & {
     current_operations: Record<string, POOL_ALLOWED_OPERATIONS>;
     default_SR?: XoSr['id'];
     HA_enabled: boolean;
+    haRebootVmOnInternalShutdown: boolean;
     haSrs: XoSr['id'][];
     id: Branded<'pool'>;
     master: XoHost['id'];
@@ -541,6 +542,18 @@ export type XoMirrorBackupJob = BaseXoJob & {
 };
 export type XoJob = BaseXoJob & {
     type: 'call';
+    method: string;
+    paramsVector?: {
+        type: string;
+        items: {
+            type?: string;
+            values?: {
+                schedules?: XoSchedule['id'][];
+                [key: string]: unknown;
+            }[];
+            [key: string]: unknown;
+        }[];
+    };
 };
 export type XoSchedule = {
     cron: string;
@@ -773,7 +786,7 @@ export type XoVtpm = BaseXapiXo & {
     type: 'VTPM';
 };
 export type XapiXoRecord = XoAlarm | XoGpuGroup | XoHost | XoMessage | XoNetwork | XoPbd | XoPci | XoPgpu | XoPif | XoPool | XoSr | XoVbd | XoVdi | XoVdiSnapshot | XoVdiUnmanaged | XoVgpu | XoVgpuType | XoVif | XoVm | XoVmController | XoVmSnapshot | XoVmTemplate | XoVtpm | XoSm;
-export type NonXapiXoRecord<TActionsByResource extends XoAclSupportedActionsByResource = never, TResource extends string = never> = AnyXoBackupArchive | AnyXoJob | AnyXoLog | XoGroup | XoProxy | XoGroup | XoProxy | XoJob | XoBackupRepository | XoSchedule | XoServer | XoTask | XoUser | XoAclRole | XoAclPrivilege<TActionsByResource, TResource>;
+export type NonXapiXoRecord<TActionsByResource extends XoAclSupportedActionsByResource = never, TResource extends string = never> = AnyXoBackupArchive | AnyXoJob | AnyXoLog | XoGroup | XoProxy | XoJob | XoBackupRepository | XoSchedule | XoServer | XoTask | XoUser | XoAclRole | XoAclPrivilege<TActionsByResource, TResource>;
 export type XoRecord<TActionsByResource extends XoAclSupportedActionsByResource = never, TResource extends string = never> = XapiXoRecord | NonXapiXoRecord<TActionsByResource, TResource>;
 export type AnyXoVm = XoVm | XoVmSnapshot | XoVmTemplate | XoVmController;
 export type AnyXoVdi = XoVdi | XoVdiSnapshot | XoVdiUnmanaged;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vates/types",
   "private": false,
-  "version": "1.26.0",
+  "version": "1.28.0",
   "main": "./dist/index.mjs",
   "exports": {
     ".": {
@@ -32,7 +32,7 @@
   "devDependencies": {
     "@eslint/js": "^9.19.0",
     "typescript": "~5.6.3",
-    "typescript-eslint": "^8.23.0"
+    "typescript-eslint": "^8.61.0"
   },
   "scripts": {
     "build": "tsc",