@ohos.enterprise.systemManager （系统管理）

本模块提供系统管理能力。

说明：

本模块首批接口从API version 12开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

本模块接口仅可在Stage模型下使用。

本模块接口仅对设备管理应用开放，且调用接口前需激活设备管理应用，具体请参考MDM Kit开发指南。

导入模块

import { systemManager } from '@kit.MDMKit';

systemManager.setNTPServer

setNTPServer(admin: Want, server: string): void

设置NTP时间服务器。

需要权限： ohos.permission.ENTERPRISE_MANAGE_SYSTEM

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

错误码：

以下错误码的详细介绍请参见企业设备管理错误码和通用错误码。

示例：

import { Want } from '@kit.AbilityKit';

let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
let server: string = "ntpserver.com";
try {
  systemManager.setNTPServer(wantTemp, server);
  console.info('Succeeded in setting NTPserver.');
} catch (err) {
  console.error(`Failed to set ntp server. Code is ${err.code}, message is ${err.message}`);
}

systemManager.getNTPServer

getNTPServer(admin: Want): string

获取NTP时间服务器信息。

需要权限： ohos.permission.ENTERPRISE_MANAGE_SYSTEM

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

返回值：

错误码：

以下错误码的详细介绍请参见企业设备管理错误码和通用错误码。

示例：

import { Want } from '@kit.AbilityKit';
import { BusinessError } from '@ohos.base';

let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
try {
  systemManager.getNTPServer(wantTemp);
  console.info('Succeeded in getting NTP server.');
} catch (err) {
  console.error(`Failed to get ntp server. Code is ${err.code}, message is ${err.message}`);
}

systemManager.setOtaUpdatePolicy

setOtaUpdatePolicy(admin: Want, policy: OtaUpdatePolicy): void

设置升级策略。内网升级场景下，需要先调用systemManager.notifyUpdatePackages接口通知系统更新包，再调用该接口设置升级策略。

需要权限： ohos.permission.ENTERPRISE_MANAGE_SYSTEM

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

错误码：

以下错误码的详细介绍请参见企业设备管理错误码和通用错误码。

示例：

import { Want } from '@kit.AbilityKit';

let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
// 默认升级策略
let otaUpdatePolicy1: systemManager.OtaUpdatePolicy = {
  "policyType": systemManager.PolicyType.DEFAULT,
  "version": "version_1.0.0.0",
};
try {
  systemManager.setOtaUpdatePolicy(wantTemp, otaUpdatePolicy1);
  console.info('Succeeded in setting ota update policy.');
} catch (err) {
  console.error(`Failed to set ota update policy. Code is ${err.code}, message is ${err.message}`);
}
// 禁止升级
let otaUpdatePolicy2: systemManager.OtaUpdatePolicy = {
  "policyType": systemManager.PolicyType.PROHIBIT,
  "version": "version_1.0.0.1",
};
try {
  systemManager.setOtaUpdatePolicy(wantTemp, otaUpdatePolicy2);
  console.info('Succeeded in setting ota update policy.');
} catch (err) {
  console.error(`Failed to set ota update policy. Code is ${err.code}, message is ${err.message}`);
}
// 强制升级
let otaUpdatePolicy3: systemManager.OtaUpdatePolicy = {
  "policyType": systemManager.PolicyType.UPDATE_TO_SPECIFIC_VERSION,
  "version": "version_1.0.0.2",
  "latestUpdateTime": 1716343200, // 时间戳
};
try {
  systemManager.setOtaUpdatePolicy(wantTemp, otaUpdatePolicy3);
  console.info('Succeeded in setting ota update policy.');
} catch (err) {
  console.error(`Failed to set ota update policy. Code is ${err.code}, message is ${err.message}`);
}
// 指定时间窗口升级
let otaUpdatePolicy4: systemManager.OtaUpdatePolicy = {
  "policyType": systemManager.PolicyType.WINDOWS,
  "version": "version_1.0.0.3",
  "installStartTime": 1716281049, // // 时间戳
  "installEndTime": 1716343200, // // 时间戳
};
try {
  systemManager.setOtaUpdatePolicy(wantTemp, otaUpdatePolicy4);
  console.info('Succeeded in setting ota update policy.');
} catch (err) {
  console.error(`Failed to set ota update policy. Code is ${err.code}, message is ${err.message}`);
}
// 延迟升级
let otaUpdatePolicy5: systemManager.OtaUpdatePolicy = {
  "policyType": systemManager.PolicyType.POSTPONE,
  "version": "version_1.0.0.4",
  "delayUpdateTime": 5, // 单位（小时）
};
try {
  systemManager.setOtaUpdatePolicy(wantTemp, otaUpdatePolicy5);
  console.info('Succeeded in setting ota update policy.');
} catch (err) {
  console.error(`Failed to set ota update policy. Code is ${err.code}, message is ${err.message}`);
}
// 禁用公网升级
let otaUpdatePolicy6: systemManager.OtaUpdatePolicy = {
  "policyType": systemManager.PolicyType.DEFAULT,
  "version": "version_1.0.0.5",
  "disableSystemOtaUpdate": true,
};
try {
  systemManager.setOtaUpdatePolicy(wantTemp, otaUpdatePolicy6);
  console.info('Succeeded in setting ota update policy.');
} catch (err) {
  console.error(`Failed to set ota update policy. Code is ${err.code}, message is ${err.message}`);
}

systemManager.getOtaUpdatePolicy

getOtaUpdatePolicy(admin: Want): OtaUpdatePolicy

查询升级策略。

需要权限： ohos.permission.ENTERPRISE_MANAGE_SYSTEM

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

返回值：

错误码：

以下错误码的详细介绍请参见企业设备管理错误码和通用错误码。

示例：

import { Want } from '@kit.AbilityKit';

let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
try {
  let policy: systemManager.OtaUpdatePolicy= systemManager.getOtaUpdatePolicy(wantTemp);
  console.info(`Succeeded in getting update policy: ${JSON.stringify(policy)}`);
} catch (err) {
  console.error(`Failed to get update policy. Code is ${err.code}, message is ${err.message}`);
}

systemManager.notifyUpdatePackages

notifyUpdatePackages(admin: Want, packageInfo: UpdatePackageInfo): Promise<void>

通知系统更新包信息。内网升级场景下，需要先调用该接口通知系统更新包，再调用systemManager.setOtaUpdatePolicy设置升级策略。

需要权限： ohos.permission.ENTERPRISE_MANAGE_SYSTEM

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

返回值：

错误码：

以下错误码的详细介绍请参见企业设备管理错误码和通用错误码。

示例：

import { BusinessError } from '@kit.BasicServicesKit';
import { Want } from '@kit.AbilityKit';

let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
let notify: systemManager.NotifyDescription = {
  "installTips": "installTips",
  "installTipsDetail": "installTips detail"
}
let description: systemManager.PackageDescription = {
  "notify": notify,
}
let updatePackages: Array<systemManager.Package> = [{
  "type": systemManager.PackageType.FIRMWARE,
  "path": "path",
  "fd": 60,
}]
let updatePackageInfo: systemManager.UpdatePackageInfo = {
  "version" : "1.0",
  "packages" : updatePackages,
  "description" : description,
};
systemManager.notifyUpdatePackages(wantTemp, updatePackageInfo).then(() => {
  console.info('Succeeded in notifying update packages.');
}).catch ((error: BusinessError) => {
  console.error(`Failed to notify update packages. Code is ${error.code},message is ${error.message}`);
});

systemManager.getUpdateResult

getUpdateResult(admin: Want, version: string): Promise<UpdateResult>

获取系统更新结果。

需要权限： ohos.permission.ENTERPRISE_MANAGE_SYSTEM

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

返回值：

错误码：

以下错误码的详细介绍请参见企业设备管理错误码和通用错误码。

示例：

import { BusinessError } from '@kit.BasicServicesKit';
import { Want } from '@kit.AbilityKit';

let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
systemManager.getUpdateResult(wantTemp, "1.0").then((result:systemManager.UpdateResult) => {
    console.info(`Succeeded in getting update result: ${JSON.stringify(result)}`);
  }).catch((error: BusinessError) => {
    console.error(`Get update result failed. Code is ${error.code},message is ${error.message}`);
  });

systemManager.getUpdateAuthData¹⁹⁺

getUpdateAuthData(admin: Want): Promise<string>

获取系统更新的鉴权数据，用于校验系统更新信息。使用Promise异步回调。

需要权限： ohos.permission.ENTERPRISE_MANAGE_SYSTEM

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

返回值：

错误码：

以下错误码的详细介绍请参见企业设备管理错误码和通用错误码。

示例：

import { BusinessError } from '@kit.BasicServicesKit';
import { Want } from '@kit.AbilityKit';

let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
systemManager.getUpdateAuthData(wantTemp).then((result: string) => {
    console.info(`Succeeded in getting update auth data: ${JSON.stringify(result)}`);
  }).catch((error: BusinessError) => {
    console.error(`Get update auth data failed. Code is ${error.code},message is ${error.message}`);
  });

SystemUpdateInfo

待更新的系统版本信息。

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

OtaUpdatePolicy

升级策略。

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

PolicyType

升级策略类型枚举。

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

UpdatePackageInfo

系统更新包信息。

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

Package

系统更新包详情。

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

PackageDescription

系统更新包描述信息。

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

NotifyDescription

企业自定义更新通知说明。

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

UpdateResult

系统更新结果信息。

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

ErrorInfo

系统更新错误信息。

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

PackageType

系统更新包类型。

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

UpdateStatus

系统更新状态。

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Mdm Kit（企业设备管理服务）

harmony 鸿蒙企业设备管理错误码

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility（企业设备管理扩展能力）

harmony 鸿蒙@ohos.enterprise.accountManager（账户管理）(系统接口)

harmony 鸿蒙@ohos.enterprise.accountManager（账户管理）

harmony 鸿蒙@ohos.enterprise.adminManager（企业设备管理）(系统接口)

harmony 鸿蒙@ohos.enterprise.adminManager (admin权限管理)

harmony 鸿蒙@ohos.enterprise.applicationManager（应用管理）(系统接口)

harmony 鸿蒙@ohos.enterprise.applicationManager（应用管理）

harmony 鸿蒙@ohos.enterprise.bluetoothManager（蓝牙管理）(系统接口)