• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# edm工具
2<!--Kit: MDM Kit-->
3<!--Subsystem: Customization-->
4<!--Owner: @huanleima-->
5<!--Designer: @liuzuming-->
6<!--Tester: @lpw_work-->
7<!--Adviser: @Brilliantry_Rui-->
8
9Enterprise Device Manager(企业设备管理工具,简称为edm),为设备管理应用提供调试和测试能力,例如激活企业设备管理拓展能力、解除激活企业设备管理拓展能力。
10
11## 环境要求
12
13在使用本工具前,开发者需要先获取<!--Del-->[<!--DelEnd-->hdc工具<!--Del-->](../../device-dev/subsystems/subsys-toolchain-hdc-guide.md)<!--DelEnd-->,执行hdc shell。
14
15## edm工具命令列表
16
17| 命令          | 描述                                                         |
18| ------------- | ------------------------------------------------------------ |
19| help          | 帮助命令,用于查询edm支持的命令信息。                        |
20| enable-admin  | 激活命令,用于激活企业设备管理拓展能力,目标组件必须为[enterpriseAdmin类型的ExtensionAbility](../mdm/mdm-kit-admin.md)。 |
21| disable-admin | 解除激活命令,用于解除激活企业设备管理拓展能力。             |
22
23## 帮助命令(help)
24
25
26  ```bash
27# 显示帮助信息
28edm help
29  ```
30
31## 激活命令(enable-admin)
32
33
34  ```bash
35# 显示帮助信息
36edm enable-admin -h
37# 激活
38edm enable-admin -n <bundleName> -a <abilityName> [-t <adminType>]
39  ```
40
41**激活命令参数列表**
42
43| 参数              | 参数说明                                                     |
44| ----------------- | ------------------------------------------------------------ |
45| -h/--help         | 帮助信息。                                                   |
46| -n/--bundle-name  | 必选参数,bundleName。                                       |
47| -a/--ability-name | 必选参数,abilityName。                                      |
48| -t/--admin-type   | 可选参数,adminType。<br/>取值如下:<br/>super - 表示激活为超级设备管理应用。<br/>byod - 表示激活为BYOD(自带设备办公)设备管理应用。<br/>缺省值为super。 |
49
50 **示例**:
51
52```bash
53# 激活一个所在应用包名为com.example.mdmsample,类名为EnterpriseAdminAbility的EnterpriseAdminExtensionAbility。
54edm enable-admin -n com.example.mdmsample -a com.example.mdmsample.EnterpriseAdminAbility
55# 执行结果
56enable-admin success.
57```
58
59
60## 解除激活命令(disable-admin)
61
62  ```bash
63# 显示帮助信息
64edm disable-admin -h
65# 解除激活
66edm disable-admin -n <bundleName>
67  ```
68
69**解除激活命令参数列表**
70
71| 参数             | 参数说明               |
72| ---------------- | ---------------------- |
73| -h/--help        | 帮助信息。             |
74| -n/--bundle-name | 必选参数,bundleName。 |
75
76  **示例**:
77
78
79  ```bash
80# 解除激活所在应用包名为com.example.mdmsample的EnterpriseAdminExtensionAbility。
81edm disable-admin -n com.example.mdmsample
82# 执行结果
83disable-admin success.
84  ```
85
86## edm工具错误信息
87
88### error: command requires option
89
90**错误描述**
91
92未传入bundleName和abilityName。
93
94**可能原因**
95
96未传入bundleName和abilityName。
97
98**处理步骤**
99
1001、如果当前使用的命令是enable-admin,请补充-n \<bundle-name\>和-a \<ability-name\>参数。
101
1022、如果当前使用的命令是disable-admin,请补充-n \<bundle-name\>参数。
103
104### error: -n, --bundle-name option requires an argument
105
106**错误描述**
107
108传入的bundleName为空。
109
110**可能原因**
111
112传入的bundleName为空。
113
114**处理步骤**
115
116检查-n后的参数,请补充bundleName。
117
118### error: -a, --ability-name option requires an argument
119
120**错误描述**
121
122 传入的abilityName为空。
123
124**可能原因**
125
126 传入的abilityName为空。
127
128**处理步骤**
129
130检查-a后的参数,请补充abilityName。
131
132### error: unknown option
133
134**错误描述**
135
136 传入了未知的参数。
137
138**可能原因**
139
140 传入了未知的参数。
141
142**处理步骤**
143
144请确认参数是否在参数列表中。
145
146### error: -n \<bundle-name\> is expected
147
148**错误描述**
149
150未传入bundleName。
151
152**可能原因**
153
154未传入bundleName。
155
156**处理步骤**
157
158请补充-n \<bundle-name\>。
159
160### error: -a \<ability-name\> is expected
161
162**错误描述**
163
164未传入abilityName。
165
166**可能原因**
167
168未传入abilityName。
169
170**处理步骤**
171
172请补充-a \<ability-name\>。
173
174### 9200003 error: the administrator ability component is invalid
175
176**错误描述**
177
178传入的bundleName或者abilityName不正确或者不是enterpriseAdmin类型的ExtensionAbility。
179
180**可能原因**
181
1821、传入的bundleName不正确。
183
1842、传入的abilityName不正确。
185
1863、传入的不是enterpriseAdmin类型的ExtensionAbility。
187
188**处理步骤**
189
190查询应用的bundleName和enterpriseAdmin类型的ExtensionAbility的abilityName,并将其传入到参数中。
191
192### 9200004 error: failed to enable the administrator application of the device
193
194**错误描述**
195
196激活失败。
197
198**可能原因**
199
2001、传入的bundleName不正确。
201
2022、传入的不是enterpriseAdmin类型的ExtensionAbility。
203
2043、存在已激活的正式的enterpriseAdmin类型的ExtensionAbility。
205
206**处理步骤**
207
2081、查询应用的bundleName和enterpriseAdmin类型的ExtensionAbility的abilityName,并将其传入到参数中。
209
2102、请使用未被管控的设备进行调试。
211
212### 9200005 error: failed to disable the administrator application of the device
213
214**错误描述**
215
216解除激活失败。
217
218**可能原因**
219
2201、此组件未被激活。
221
2222、此组件不是通过hdc命令被激活的。
223
2243、解除激活失败。
225
226**处理步骤**
227
228查询可以被hdc命令解除激活的应用的bundleName,并将其传入到参数中。