Администрирование приложений с помощью Ant
improve this page | report issueОбзор
Для администрирования приложений MobileFirst можно использовать задачу Ant mfpadm.
Перейти к
Сравнение с другими средствами
Операции администрирования в IBM Mobile Foundation можно выполнять следующими способами:
- MobileFirst Operations Console (интерактивный режим).
- Задача Ant mfpadm.
- Программа mfpadm.
- Службы REST администрирования MobileFirst.
Задача Ant mfpadm, программа mfpadm и службы REST оптимальным образом подходят для автоматизации операций, включая следующие сценарии:
- Устранение ошибок оператора в повторяющихся операциях
- Обеспечение работы, когда оператора нет на рабочем месте
- Настройка рабочего сервера в соответствии с конфигурацией тестового или промежуточного сервера.
задача Ant mfpadm и программа mfpadm отличаются большей простотой использования и более удобными средствами создания отчетов об ошибках по сравнению со службами REST. Преимущество задачи Ant mfpadm над программой mfpadm заключается в том, что она не зависит от платформы и ее проще интегрировать, если уже доступна интеграция с Ant.
Предварительные требования
Инструмент mfpadm устанавливается программой установки MobileFirst Server. Далее на этой странице product_install_dir
- это установочный каталог программы установки MobileFirst Server.
Для запуска задачи mfpadm требуется Apache Ant. Дополнительная информация о минимальной поддерживаемой версии Ant приведена в разделе Системные требования.
Для удобства в состав MobileFirst Server входит Apache Ant 1.9.4. В каталоге product_install_dir/shortcuts/ расположены следующие сценарии.
- ant для UNIX / Linux
- ant.bat для Windows
Сценарии готовы к работе и не требуют настройки каких-либо переменных среды. Если задана переменная среды JAVA_HOME, сценарии принимают ее.
Задачу Ant mfpadm можно использовать не только в той системе, в которой установлен сервер MobileFirst Server.
- Скопируйте файл product_install_dir/MobileFirstServer/mfp-ant-deployer.jar в систему.
- Убедитесь, что в системе установлены поддерживаемые версии Apache Ant и среды выполнения Java.
Для применения задачи Ant mfpadm добавьте следующую команду инициализации в сценарий Ant:
<taskdef resource="com/ibm/mfp/ant/deployers/antlib.xml">
<classpath>
<pathelement location="product_install_dir/MobileFirstServer/mfp-ant-deployer.jar"/>
</classpath>
</taskdef>
Другие команды инициализации, в которых указан тот же файл mfp-ant-deployer.jar, не требуются, поскольку antlib.xml неявным образом выполняет инициализацию с помощью файла defaults.properties. Пример избыточной команды инициализации:
<taskdef resource="com/ibm/mfp/ant/defaults.properties">
<classpath>
<pathelement location="product_install_dir/MobileFirstServer/mfp-ant-deployer.jar"/>
</classpath>
</taskdef>
Дополнительная информация о работе с программой установки MobileFirst Server приведена в разделе Запуск IBM Installation Manager.
Перейти к
- Вызов задачи Ant mfpadm
- Команды для общей настройки
- Команды для адаптеров
- Команды для приложений
- Команды для устройств
- Команды для устранения неполадок
Вызов задачи Ant mfpadm
С помощью задачи Ant mfpadm и связанных команд можно администрировать приложения MobileFirst. Вызовите задачу Ant mfpadm следующим образом:
<mfpadm url=... user=... password=...|passwordfile=... [secure=...]>
команды
</mfpadm>
Атрибуты
Задача Ant mfpadm имеет следующие атрибуты:
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
url | Основной URL веб-приложения MobileFirst для служб администрирования | Да | |
secure | Позволяет избегать операций с рисками безопасности | Нет | true |
user | Имя пользователя для доступа к службам администрирования MobileFirst | Да | |
password | Пароль пользователя | Требуется один из вариантов | |
passwordfile | Файл, содержащий пароль пользователя | Требуется один из вариантов | |
timeout | Тайм-аут доступа к службе REST, в секундах | Нет | |
connectTimeout | Тайм-аут установки сетевого соединения, в секундах | Нет | |
socketTimeout | Тайм-аут обнаружения потери сетевого соединения, в секундах | Нет | |
connectionRequestTimeout | Тайм-аут получения записи из пула запросов соединений, в секундах | Нет | |
lockTimeout | Тайм-аут получения блокировки | Нет |
url
В базовом URL рекомендуется использовать протокол HTTPS. Например, если применяются порты и корневые контексты по умолчанию, укажите следующий URL.
- Для WebSphere Application Server: https://server:9443/worklightadmin
- Для Tomcat: https://server:8443/worklightadmin
secure
Значение по умолчанию: true. Параметр secure=”false” может вызвать следующие эффекты:
- Имя пользователя и пароль могут передаваться в незащищенном виде (даже по соединениям HTTP).
- Сертификаты SSL сервера принимаются даже в том случае, если они являются собственными или созданы для другого имени хоста.
password
Укажите пароль в сценарии Ant, с помощью атрибута password
или в отдельном файле, который передается с помощью атрибута
passwordfile. Пароль относится к конфиденциальной информации и
требует защиты. Вы должны исключить доступ других пользователей системы к паролям. Для
того чтобы защитить пароль, перед добавлением пароля в файл настройте права
доступа к файлу таким образом, чтобы только вы могли просматривать его. Например, можно
выполнить одну из следующих команд:
- UNIX:
chmod 600 adminpassword.txt
- Windows:
cacls adminpassword.txt /P Administrators:F %USERDOMAIN%\%USERNAME%:F
Кроме того, пароль можно замаскировать, чтобы скрыть его от случайных зрителей. Для этого сохраните нечитаемый пароль в файле конфигурации с помощью команды mfpadm config password. Нечитаемый пароль можно скопировать и выставить в сценарий Ant или файл пароля.
Вызов mfpadm содержит команды, закодированные во внутренних элементах. Команды выполняются в том порядке, в котором они перечислены. Если возникнет сбой одной из команд, то остальные команды не выполняются и вызов mfpadm возвращает код ошибки.
Элементы
В вызовах mfpadm можно использовать следующие элементы:
Элемент | Описание | Число |
---|---|---|
show-info | Отображает информацию о пользователе и конфигурации | 0..∞ |
show-global-config | Отображает информацию о глобальной конфигурации | 0..∞ |
show-diagnostics | Отображает диагностическую информацию | 0..∞ |
show-versions | Отображает информацию о версиях | 0..∞ |
unlock | Освобождает блокировку общего назначения | 0..∞ |
list-runtimes | Отображает список сред выполнения | 0..∞ |
show-runtime | Отображает информацию о среде выполнения | 0..∞ |
delete-runtime | Удаляет среду выполнения | 0..∞ |
show-user-config | Отображает конфигурацию пользователей среды выполнения | 0..∞ |
set-user-config | Задает конфигурацию пользователей среды выполнения | 0..∞ |
show-confidential-clients | Отображает конфигурации конфиденциальных клиентов среды выполнения | 0..∞ |
set-confidential-clients | Задает конфигурации конфиденциальных клиентов среды выполнения | 0..∞ |
set-confidential-clients-rule | Задает правило для конфигурации конфиденциальных клиентов среды выполнения. | 0..∞ |
list-adapters | Отображает список адаптеров | 0..∞ |
deploy-adapter | Развертывает адаптер | 0..∞ |
show-adapter | Отображает информацию об адаптере | 0..∞ |
delete-adapter | Удаляет адаптер | 0..∞ |
adapter | Другие операции над адаптером | 0..∞ |
list-apps | Отображает список приложений | 0..∞ |
deploy-app | Развертывает приложение | 0..∞ |
show-app | Отображает информацию о приложении | 0..∞ |
delete-app | Удаляет приложение | 0..∞ |
show-app-version | Отображает информацию о версии приложения | 0..∞ |
delete-app-version | Удаляет версию приложения | 0..∞ |
app | Другие операции над приложением | 0..∞ |
app-version | Другие операции над версией приложения | 0..∞ |
list-devices | Отображает список устройств | 0..∞ |
remove-device | Удаляет устройство | 0..∞ |
device | Другие операции над устройством | 0..∞ |
list-farm-members | Отображает список элементов фермы серверов | 0..∞ |
remove-farm-member | Удаляет элемент фермы серверов | 0..∞ |
Формат XML
В большинстве случаев команды создают вывод в формате
XML. Кроме того, отдельные команды, такие как <set-accessrule>
,
принимают входные данные в формате XML. Схемы XML этих форматов XML можно просмотреть в
каталоге product_install_dir/MobileFirstServer/mfpadm-schemas/.
Команды, которые получают ответ XML от сервера, проверяют соответствие этого ответа
конкретной схеме. Эту проверку можно выключить с помощью атрибута
xmlvalidation=”none”.
Целевой набор символов
Задача Ant mfpadm создает вывод в кодировке текущей локали. В Windows применяется кодовая страница ANSI. Это вызывает следующие эффекты:
- Символы, которые не принадлежат этому набору символов, в выводе преобразуются в знаки вопроса.
- Если вывод передается в окно командной строки Windows (cmd.exe), то символы, отличные от ASCII, отображаются неправильным образом, поскольку в таких окнах по умолчанию применяется кодовая страница OEM.
Для обхода этого ограничения выполните следующие действия:
- В операционных системах, отличных от Windows, применяется локаль с кодировкой UTF-8. Этот формат - локаль по умолчанию в системах Red Hat Linux и macOS. Многие другие операционные системы используют локаль en_US.UTF-8.
- С помощью атрибута output=”имя файла” можно перенаправить вывод команды mfpadm в файл.
Команды для общей настройки
При вызове задачи Ant mfpadm можно указать различные команды, обращающиеся к глобальной конфигурации IBM MobileFirst Server или среды выполнения.
Команда show-global-config
Команда show-global-config
отображает глобальную
конфигурацию. Она имеет следующие атрибуты:
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
output | Имя файла вывода. | Нет | Неприменимо |
outputproperty | Имя свойства Ant для вывода. | Нет | Неприменимо |
Пример
<show-global-config/>
Эта команда основана на службе REST Глобальная конфигурация (GET).
Команда show-user-config
Команда show-user-config
за пределами элементов
<adapter>
и <app-version>
отображает
конфигурацию пользователей среды выполнения. Она имеет следующие атрибуты:
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
runtime | Имя среды выполнения. | Да | Недоступно |
format | Задает формат вывода: json или xml. | Да | Недоступно |
output | Имя файла вывода. | Нет | Неприменимо |
outputproperty | Имя свойства Ant для сохранения вывода. | Нет | Неприменимо |
Пример
<show-user-config runtime="mfp" format="xml"/>
Эта команда основана на службе REST Конфигурация среды выполнения (GET).
Команда set-user-config
Команда set-user-config
за пределами элементов
<adapter>
и <app-version>
задает конфигурацию
пользователей среды выполнения. Она имеет следующие атрибуты для указания всей
конфигурации.
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
runtime | Имя среды выполнения. | Да | Недоступно |
file | Имя файла JSON или XML, содержащего новую конфигурацию. | Да | Недоступно |
Команда set-user-config
позволяет указать отдельные свойства
конфигурации с помощью следующих атрибутов.
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
runtime | Имя среды выполнения. | Да | Недоступно |
property | Имя свойства JSON. Вложенные свойства можно указать в формате prop1.prop2…..propN. Для элемента массива JSON укажите индекс вместо имени свойства. | Да | Недоступно |
value | Значение свойства. | Да | Недоступно |
Пример
<set-user-config runtime="mfp" file="myconfig.json"/>
<set-user-config runtime="mfp" property="timeout" value="240"/>
Эта команда основана на службе REST Конфигурация среды выполнения (PUT).
Команда show-confidential-clients
Команда show-confidential-clients
отображает
конфигурацию конфиденциальных клиентов, обладающих доступом к среде выполнения. Дополнительная информация о конфиденциальных клиентах приведена в разделе
Конфиденциальные
клиенты. Эта команда имеет следующие атрибуты:
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
runtime | Имя среды выполнения. | Да | Недоступно |
format | Задает формат вывода: json или xml. | Да | Недоступно |
output | Имя файла вывода. | Нет | Неприменимо |
outputproperty | Имя свойства Ant для сохранения вывода. | Нет | Неприменимо |
Пример
<show-confidential-clients runtime="mfp" format="xml" output="clients.xml"/>
Эта команда основана на службе REST Конфиденциальные клиенты (GET).
Команда set-confidential-clients
Команда set-confidential-clients
задает
конфигурацию конфиденциальных клиентов, обладающих доступом к среде выполнения. Дополнительная информация о конфиденциальных клиентах приведена в разделе
Конфиденциальные
клиенты. Эта команда имеет следующие атрибуты:
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
runtime | Имя среды выполнения. | Да | Недоступно |
file | Имя файла JSON или XML, содержащего новую конфигурацию. | Да | Недоступно |
Пример
<set-confidential-clients runtime="mfp" file="clients.xml"/>
Эта команда основана на службе REST Конфиденциальные клиенты (PUT).
Команда set-confidential-clients-rule
Команда set-confidential-clients-rule
задает
правило в конфигурации конфиденциальных клиентов, обладающих доступом к среде выполнения. Дополнительная информация о конфиденциальных клиентах приведена в разделе
Конфиденциальные
клиенты. Эта команда имеет следующие атрибуты:
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
runtime | Имя среды выполнения. | Да | Недоступно |
id | Идентификатор правила. | Да | Недоступно |
displayName | Отображаемое имя правила. | Да | Недоступно |
secret | Пароль правила. | Да | Недоступно |
allowedScope | Область действия правила. Список маркеров через пробел. | Да | Недоступно |
Пример
<set-confidential-clients-rule runtime="mfp" id="push" displayName="Push" secret="lOa74Wxs" allowedScope="**"/>
Эта команда основана на службе REST Конфиденциальные клиенты (PUT).
Команды для адаптеров
При вызове задачи Ant mfpadm можно указать различные команды для адаптеров.
Команда list-adapters
Команда list-adapters
возвращает список адаптеров,
развернутых для конкретной среды выполнения. Она имеет следующие атрибуты.
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
runtime | Имя среды выполнения. | Да | Недоступно |
output | Имя файла вывода. | Нет | Неприменимо |
outputproperty | Имя свойства Ant для вывода. | Нет | Неприменимо |
Пример
<list-adapters runtime="mfp"/>
Эта команда основана на службе REST Адаптеры (GET).
Команда deploy-adapter
Команда deploy-adapter
развертывает адаптер в среде
выполнения. Она имеет следующие атрибуты.
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
runtime | Имя среды выполнения. | Да | Недоступно |
file | Двоичный файл адаптера (.adapter). | Да | Недоступно |
Пример
<deploy-adapter runtime="mfp" file="MyAdapter.adapter"/>
Эта команда основана на службе REST Адаптеры (POST).
Команда show-adapter
Команда show-adapter
отображает сведения об адаптере. Она имеет следующие атрибуты.
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
runtime | Имя среды выполнения. | Да | Недоступно |
name | Имя адаптера. | Да | Недоступно |
output | Имя файла вывода. | Нет | Неприменимо |
outputproperty | Имя свойства Ant для вывода. | Нет | Неприменимо |
Пример
<show-adapter runtime="mfp" name="MyAdapter"/>
Эта команда основана на службе REST Адаптеры (GET).
Команда delete-adapter
Команда delete-adapter
удаляет (отменяет развертывание)
адаптера из среды выполнения. Она имеет следующие атрибуты.
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
runtime | Имя среды выполнения. | Да | Недоступно |
name | Имя адаптера. | Да | Недоступно |
Пример
<delete-adapter runtime="mfp" name="MyAdapter"/>
Эта команда основана на службе REST Адаптер (DELETE).
Группа команд adapter
Группа команд adapter
имеет следующие атрибуты.
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
runtime | Имя среды выполнения. | Да | Недоступно |
name | Имя адаптера. | Да | Недоступно |
Команда adapter
поддерживает следующие атрибуты.
Элемент | Описание | Число |
---|---|---|
get-binary | Получает двоичные данные. | 0..∞ |
show-user-config | Отображает конфигурацию пользователей. | 0..∞ |
set-user-config | Задает конфигурацию пользователей. | 0..∞ |
Команда get-binary
Команда get-binary
в элементе <adapter>
возвращает двоичный файл адаптера.
Она имеет следующие атрибуты.
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
tofile | Имя файла вывода. | Да | Недоступно |
Пример
<adapter runtime="mfp" name="MyAdapter">
<get-binary tofile="/tmp/MyAdapter.adapter"/>
</adapter>
Эта команда основана на службе REST Адаптеры (GET).
Команда show-user-config
Команда show-user-config
в элементе <adapter>
отображает конфигурацию
пользователей адаптера. Она имеет следующие атрибуты.
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
format | Задает формат вывода: json или xml. | Да | Недоступно |
output | Имя файла вывода. | Нет | Неприменимо |
outputproperty | Имя свойства Ant для сохранения вывода. | Нет | Неприменимо |
Пример
<adapter runtime="mfp" name="MyAdapter">
<show-user-config format="xml"/>
</adapter>
Эта команда основана на службе REST Конфигурация адаптера (GET).
Команда set-user-config
Команда set-user-config
в элементе <adapter>
задает
конфигурацию пользователей адаптера. Она имеет следующие атрибуты для указания
всей конфигурации.
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
file Имя файла JSON или XML, содержащего новую конфигурацию. | Да | Недоступно |
Эта команда позволяет указать отдельные свойства конфигурации с помощью следующих атрибутов.
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
property | Имя свойства JSON. Вложенные свойства можно указать в формате prop1.prop2…..propN. Для элемента массива JSON укажите индекс вместо имени свойства. | Да | Недоступно |
value | Значение свойства. | Да | Недоступно |
Примеры
<adapter runtime="mfp" name="MyAdapter">
<set-user-config file="myconfig.json"/>
</adapter>
<adapter runtime="mfp" name="MyAdapter">
<set-user-config property="timeout" value="240"/>
</adapter>
Эта команда основана на службе REST Конфигурация приложения (PUT).
Команды для приложений
При вызове задачи Ant mfpadm можно указать различные команды для приложений.
Команда list-apps
Команда list-apps
возвращает список приложений, развернутых в среде выполнения. Она имеет следующие атрибуты.
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
runtime | Имя среды выполнения. | Да Недоступно | |
output | Имя файла вывода. | Нет Неприменимо | |
outputproperty | Имя свойства Ant для вывода. | Нет | Неприменимо |
Пример
<list-apps runtime="mfp"/>
Эта команда основана на службе REST Приложения (GET).
Команда deploy-app
Команда deploy-app
развертывает версию приложения в среде
выполнения. Она имеет следующие атрибуты.
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
runtime | Имя среды выполнения. | Да | Недоступно |
file | Дескриптор приложения, файл JSON. | Да | Недоступно |
Пример
<deploy-app runtime="mfp" file="MyApp/application-descriptor.json"/>
Эта команда основана на службе REST Приложение (POST).
Команда show-app
Команда show-app
возвращает список версий приложений, развернутых в среде
выполнения. Она имеет следующие атрибуты.
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
runtime | Имя среды выполнения. | Да | Недоступно |
name | Имя приложения. | Да | Недоступно |
output | Имя файла вывода. | Нет | Неприменимо |
outputproperty | Имя свойства Ant для вывода. | Нет | Неприменимо |
Пример
<show-app runtime="mfp" name="MyApp"/>
Эта команда основана на службе REST Приложение (GET).
Команда delete-app
Команда delete-app
удаляет (отменяет развертывание) приложение из
среды выполнения, включая все развернутые версии приложения. Она имеет следующие атрибуты.
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
runtime | Имя среды выполнения. | Да | Недоступно |
name | Имя приложения. | Да | Недоступно |
Пример
<delete-app runtime="mfp" name="MyApp"/>
Эта команда основана на службе REST Версия приложения (DELETE).
Команда show-app-version
Команда show-app-version
отображает сведения о версии
приложения в среде выполнения. Она имеет следующие атрибуты.
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
runtime Имя среды выполнения. | Да | Недоступно | |
name Имя приложения. | Да | Недоступно | |
environment Мобильная платформа. | Да | Недоступно | |
version Номер версии приложения. | Да | Недоступно |
Пример
<show-app-version runtime="mfp" name="MyApp" environment="iphone" version="1.1"/>
Эта команда основана на службе REST Версия приложения (GET).
Команда delete-app-version
Команда delete-app-version
удаляет (отменяет
развертывание) версии приложения из среды выполнения. Она имеет следующие атрибуты.
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
runtime Имя среды выполнения. | Да | Недоступно | |
name Имя приложения. | Да | Недоступно | |
environment Мобильная платформа. | Да | Недоступно | |
version Номер версии приложения. | Да | Недоступно |
Пример
<delete-app-version runtime="mfp" name="MyApp" environment="iphone" version="1.1"/>
Эта команда основана на службе REST Версия приложения (DELETE).
Группа команд app
Группа команд app
имеет следующие атрибуты.
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
runtime Имя среды выполнения. | Да | Недоступно | |
name Имя приложения. | Да | Недоступно |
Группа команд app поддерживает следующие элементы.
Элемент | Описание | Число |
---|---|---|
show-license-config | Показывает конфигурацию лицензий на основе маркеров. | 0.. |
set-license-config | Задает конфигурацию лицензий на основе маркеров. | 0.. |
delete-license-config | Удаляет конфигурацию лицензий на основе маркеров. | 0.. |
Команда show-license-config
Команда show-license-config
отображает
конфигурацию лицензий на основе маркеров приложения. Она имеет следующие атрибуты.
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
output | Имя файла вывода. | Да | Недоступно |
outputproperty | Имя свойства Ant для сохранения вывода. | Да | Недоступно |
Пример
<app-version runtime="mfp" name="MyApp" environment="iphone" version="1.1">
<show-license-config output="/tmp/MyApp-license.xml"/>
</app-version>
Эта команда основана на службе REST Конфигурация лицензий приложения (GET).
Команда set-license-config
Команда set-license-config
задает конфигурацию
лицензий на основе маркеров приложения. Она имеет следующие атрибуты.
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
appType | Тип приложения: B2C или B2E | Да | Недоступно |
licenseType | Тип приложения: APPLICATION, ADDITIONAL_BRAND_DEPLOYMENT или NON_PRODUCTION. | Да | Недоступно |
Пример
<app-version runtime="mfp" name="MyApp" environment="iphone" version="1.1">
<set-license-config appType="B2E" licenseType="APPLICATION"/>
</app-version>
Эта команда основана на службе REST Конфигурация лицензий приложения (POST).
Команда delete-license-config
Команда delete-license-config
сбрасывает
конфигурацию лицензий приложения (возвращает ее в начальное состояние).
Пример
<app-version runtime="mfp" name="MyApp" environment="iphone" version="1.1">
<delete-license-config/>
</app-version>
Эта команда основана на службе REST Конфигурация лицензий (DELETE).
Группа команд app-version
Группа команд app-version
имеет следующие атрибуты.
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
runtime | Имя среды выполнения. | Да | Недоступно |
name | Имя приложения. | Да | Недоступно |
environment | Мобильная платформа. | Да | Недоступно |
version | Версия приложения. | Да | Недоступно |
Группа команд app-version
поддерживает следующие элементы:
Элемент | Описание | Число |
---|---|---|
get-descriptor | Получает дескриптор. | 0.. |
get-web-resources | Получает веб-ресурсы. | 0.. |
set-web-resources | Задает веб-ресурсы. | 0.. |
get-authenticity-data | Получает данные о подлинности. | 0.. |
set-authenticity-data | Задает данные о подлинности. | 0.. |
delete-authenticity-data | Удаляет данные о подлинности. | 0.. |
show-user-config | Отображает конфигурацию пользователей. | 0.. |
set-user-config | Задает конфигурацию пользователей. | 0.. |
Команда get-descriptor
Команда get-descriptor
в элементе <app-version>
возвращает дескриптор версии приложения. Она имеет следующие атрибуты.
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
output | Имя файла вывода. | Нет | Неприменимо |
outputproperty | Имя свойства Ant для сохранения вывода. | Нет | Неприменимо |
Пример
<app-version runtime="mfp" name="MyApp" environment="iphone" version="1.1">
<get-descriptor output="/tmp/MyApp-application-descriptor.json"/>
</app-version>
Эта команда основана на службе REST Дескриптор приложения (GET).
Команда get-web-resources
Команда get-web-resources
в элементе <app-version>
возвращает
веб-ресурсы версии приложения в виде файла .zip. Она имеет следующие атрибуты.
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
tofile | Имя файла вывода. | Да | Недоступно |
Пример
<app-version runtime="mfp" name="MyApp" environment="iphone" version="1.1">
<get-web-resources tofile="/tmp/MyApp-web.zip"/>
</app-version>
Эта команда основана на службе REST Получить веб-ресурс (GET).
Команда set-web-resources
Команда set-web-resources
в элементе <app-version>
задает веб-ресурсы
для версии приложения. Она имеет следующие атрибуты.
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
file | Имя входного файла (требуется файл .zip). | Да | Недоступно |
Пример
<app-version runtime="mfp" name="MyApp" environment="iphone" version="1.1">
<set-web-resources file="/tmp/MyApp-web.zip"/>
</app-version>
Эта команда основана на службе REST Развернуть веб-ресурс (POST).
Команда get-authenticity-data
Команда get-authenticity-data
в элементе <app-version>
возвращает
данные о подлинности версии приложения. Она имеет следующие атрибуты.
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
output | Имя файла вывода. | Нет | Неприменимо |
outputproperty | Имя свойства Ant для сохранения вывода. | Нет | Неприменимо |
Пример
<app-version runtime="mfp" name="MyApp" environment="iphone" version="1.1">
<get-authenticity-data output="/tmp/MyApp.authenticity_data"/>
</app-version>
Эта команда основана на службе REST Экспортировать ресурсы среды выполнения (GET).
Команда set-authenticity-data
Команда set-authenticity-data
в элементе
<app-version>
задает данные о подлинности версии приложения. Она имеет
следующие атрибуты.
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
file | Имя входного файла:<ul><li>Файл authenticity_data</li><li>или файл устройства | ||
(.ipa, .apk или .appx), из которого извлекаются данные о подлинности. </li></ul> | Да | Недоступно |
Примеры
<app-version runtime="mfp" name="MyApp" environment="iphone" version="1.1">
<set-authenticity-data file="/tmp/MyApp.authenticity_data"/>
</app-version>
<app-version runtime="mfp" name="MyApp" environment="iphone" version="1.1">
<set-authenticity-data file="MyApp.ipa"/>
</app-version>
<app-version runtime="mfp" name="MyApp" environment="android" version="1.1">
<set-authenticity-data file="MyApp.apk"/>
</app-version>
Эта команда основана на службе REST Развернуть данные о подлинности приложения (POST).
Команда delete-authenticity-data
Команда delete-authenticity-data
в элементе
<app-version>
задает данные о подлинности версии приложения. Она не
имеет атрибутов.
Пример
<app-version runtime="mfp" name="MyApp" environment="iphone" version="1.1">
<delete-authenticity-data/>
</app-version>
Эта команда основана на службе REST Подлинность приложения (DELETE).
Команда show-user-config
Команда show-user-config
в элементе <app-version>
отображает конфигурацию пользователей версии приложения. Она имеет следующие атрибуты.
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
format | Задает формат вывода: json или xml. | Да | Недоступно |
output | Имя файла вывода. Нет Неприменимо | ||
outputproperty | Имя свойства Ant для вывода. | Нет | Неприменимо |
Примеры
<app-version runtime="mfp" name="MyApp" environment="iphone" version="1.1">
<show-user-config format="json" output="/tmp/MyApp-config.json"/>
</app-version>
<app-version runtime="mfp" name="MyApp" environment="iphone" version="1.1">
<show-user-config format="xml" output="/tmp/MyApp-config.xml"/>
</app-version>
Эта команда основана на службе REST Конфигурация приложения (GET).
Команда set-user-config
Команда set-user-config
в элементе <app-version>
задает конфигурацию пользователей версии приложения. Она имеет следующие атрибуты для
указания всей конфигурации.
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
file | Имя файла JSON или XML, содержащего новую конфигурацию. | Да | Недоступно |
Команда set-user-config
позволяет указать отдельные свойства
конфигурации с помощью следующих атрибутов.
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
property | Имя свойства JSON. Вложенные свойства можно указать в формате prop1.prop2…..propN. Для элемента массива JSON укажите индекс вместо имени свойства. | Да | Недоступно |
value | Значение свойства. | Да | Недоступно |
Примеры
<app-version runtime="mfp" name="MyApp" environment="iphone" version="1.1">
<set-user-config file="/tmp/MyApp-config.json"/>
</app-version>
<app-version runtime="mfp" name="MyApp" environment="iphone" version="1.1">
<set-user-config property="timeout" value="240"/>
</app-version>
Команды для устройств
При вызове задачи Ant mfpadm можно указать различные команды для устройств.
Команда list-devices
Команда list-devices
возвращает список устройств, которые
обращались к приложениям среды выполнения . Она имеет следующие атрибуты:
Атрибут | Описание | Требуется | По умолчанию | |
---|---|---|---|---|
runtime | Имя среды выполнения. | Да | Недоступно | |
query | Удобное имя или идентификатор пользователя для поиска. Этот параметр задает строку для поиска. Возвращаются все устройства, в удобных именах или идентификаторах | пользователей которых встречается указанная строка (без учета регистра символов). | Нет | Неприменимо |
output | Имя файла вывода. | Нет | Неприменимо | |
outputproperty | Имя свойства Ant для вывода. | Нет | Неприменимо |
Примеры
<list-devices runtime="mfp"/>
<list-devices runtime="mfp" query="john"/>
Эта команда основана на службе REST Устройства (GET).
Команда remove-device
Команда remove-device
очищает информацию об устройстве, которое
обращалось к приложениям среды выполнения. Она имеет следующие атрибуты:
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
runtime | Имя среды выполнения. | Да | Недоступно |
id | Уникальный идентификатор устройства. | Да | Недоступно |
Пример
<remove-device runtime="mfp" id="496E974CCEDE86791CF9A8EF2E5145B6"/>
Эта команда основана на службе REST Устройство (DELETE).
Группа команд device
Группа команд device
имеет следующие атрибуты.
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
runtime | Имя среды выполнения. | Да | Недоступно |
id | Уникальный идентификатор устройства. | Да | Недоступно |
Команда device
поддерживает следующие атрибуты.
Элемент | Описание | Число |
---|---|---|
set-status | Изменяет состояние. | 0..∞ |
set-appstatus | Изменяет состояние приложения. | 0..∞ |
Команда set-status
Команда set-status
изменяет состояние устройства в среде
выполнения. Она имеет следующие атрибуты:
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
status | Новое состояние. | Да | Недоступно |
Состояние может иметь одно из следующих значений:
- ACTIVE
- LOST
- STOLEN
- EXPIRED
- DISABLED
Пример
<device runtime="mfp" id="496E974CCEDE86791CF9A8EF2E5145B6">
<set-status status="EXPIRED"/>
</device>
Эта команда основана на службе REST Состояние устройства (PUT).
Команда set-appstatus
Команда set-appstatus
изменяет состояние устройства в
отношении приложения из среды выполнения. Она имеет следующие атрибуты:
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
app | Имя приложения. | Да | Недоступно |
status | Новое состояние. | Да | Недоступно |
Состояние может иметь одно из следующих значений:
- ENABLED
- DISABLED
Пример
<device runtime="mfp" id="496E974CCEDE86791CF9A8EF2E5145B6">
<set-appstatus app="MyApp" status="DISABLED"/>
</device>
Эта команда основана на службе REST Состояние приложения устройства (PUT).
Команды для устранения неполадок
С помощью команд задачи Ant можно анализировать неполадки, связанные с веб-приложениями MobileFirst Server.
Команда show-info
Команда show-info
отображает общую информацию о службах
администрирования MobileFirst, для возврата которой не
требуется доступ к среде выполнения или базе данных. С помощью этой команды можно
проверить, запущены ли службы администрирования MobileFirst. Она имеет следующие
атрибуты:
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
output | Имя файла вывода. | Нет | Неприменимо |
outputproperty | Имя свойства Ant для вывода. | Нет | Неприменимо |
Пример
<show-info/>
Команда show-versions
Команда show-versions
отображает версии MobileFirst различных компонентов:
- mfpadmVersion: точный номер версии MobileFirst Server, к которой относится файл mfp-ant-deployer.jar.
- productVersion: точный номер версии MobileFirst Server, к которой относится файл mfp-admin-service.war.
- mfpAdminVersion: точный номер версии компоновки файла mfp-admin-service.war.
Эта команда имеет следующие атрибуты:
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
output | Имя файла вывода. | Нет | Неприменимо |
outputproperty | Имя свойства Ant для вывода. | Нет | Неприменимо |
Пример
<show-versions/>
Команда show-diagnostics
Команда show-diagnostics
отображает состояние различных
компонентов, необходимых для правильной работы службы администрирования
MobileFirst, включая доступность базы данных и
вспомогательных служб. Эта команда имеет следующие атрибуты.
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
output | Имя файла вывода. | Нет | Неприменимо |
outputproperty | Имя свойства Ant для вывода. | Нет | Неприменимо |
Пример
<show-diagnostics/>
Команда unlock
Команда unlock
освобождает блокировку общего назначения. Отдельные
опасные операции применяют эту блокировку, чтобы предотвратить параллельное изменение
данных конфигурации. В редких случаях, когда такие операции прерываются, блокировки могут
не освобождаться, запрещая тем самым запуск других подобных операций. В таких случаях
блокировку можно снять с помощью команды unlock. Команда выполняется без
атрибутов.
Пример
<unlock/>
Команда list-runtimes
Команда list-runtimes
возвращает список развернутых сред
выполнения. Она имеет следующие атрибуты:
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
runtime | Имя среды выполнения. | Да | Недоступно |
output | Имя файла вывода. | Нет | Неприменимо |
outputproperty | Имя свойства Ant для вывода. | Нет | Неприменимо |
Примеры
<list-runtimes/>
<list-runtimes inDatabase="true"/>
Эта команда основана на службе REST Среды выполнения (GET).
Команда show-runtime
Команда show-runtime
отображает информацию о конкретной
развернутой средой выполнения. Она имеет следующие атрибуты:
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
runtime | Имя среды выполнения. | Да | Недоступно |
output | Имя файла вывода. | Нет | Неприменимо |
outputproperty | Имя свойства Ant для вывода. | Нет | Неприменимо |
Пример
<show-runtime runtime="mfp"/>
Эта команда основана на службе REST Среда выполнения (GET).
Команда delete-runtime
Команда delete-runtime
удаляет среду выполнения вместе с
приложениями и адаптерами из базы данных. Перед удалением среды выполнения остановите ее
веб-приложение. Эта команда имеет следующие атрибуты.
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
runtime | Имя среды выполнения. | Да | Недоступно |
condition | Условие для удаления среды выполнения: empty или always. Внимание: значение always может представлять опасность. | Нет | Неприменимо |
Пример
<delete-runtime runtime="mfp" condition="empty"/>
Эта команда основана на службе REST Среда выполнения (DELETE).
Команда list-farm-members
Команда list-farm-members
возвращает список серверов из
фермы, на которых развернута конкретная среда выполнения. Она имеет следующие атрибуты:
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
runtime | Имя среды выполнения. | Да | Недоступно |
output | Имя файла вывода. | Нет | Неприменимо |
outputproperty | Имя свойства Ant для вывода. | Нет | Неприменимо |
Пример
<list-farm-members runtime="mfp"/>
Эта команда основана на службе REST Элементы топологии фермы (GET).
Команда remove-farm-member
Команда remove-farm-member
удаляет сервер из списка
элементов фермы, на которых развернута конкретная среда выполнения. Эту команду следует
выполнять в случае потери доступа к серверу или его отключения. Эта команда имеет
следующие атрибуты.
Атрибут | Описание | Требуется | По умолчанию |
---|---|---|---|
runtime | Имя среды выполнения. | Да | Недоступно |
serverId | Идентификатор сервера. | Да | Неприменимо |
force | Принудительное удаление элемента сервера даже в том случае, если он доступен и подключен. | Нет | false |
Пример
<remove-farm-member runtime="mfp" serverId="srvlx15"/>
Эта команда основана на службе REST Элементы топологии фермы (DELETE).
▲Inclusive terminology note: The Mobile First Platform team is making changes to support the IBM® initiative to replace racially biased and other discriminatory language in our code and content with more inclusive language. While IBM values the use of inclusive language, terms that are outside of IBM's direct influence are sometimes required for the sake of maintaining user understanding. As other industry leaders join IBM in embracing the use of inclusive language, IBM will continue to update the documentation to reflect those changes.