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