Ant を介したアプリケーション管理

improve this page | report issue

概説

mfpadm Ant タスクを通じて MobileFirst アプリケーションを管理することができます。

ジャンプ先

他の機能との比較
前提条件

他の機能との比較

IBM Mobile Foundation の管理操作は、以下の方法で実行できます。

MobileFirst Operations Console。対話式です。
mfpadm Ant タスク。
mfpadm プログラム。
MobileFirst 管理 REST サービス。

mfpadm Ant タスク、mfpadm プログラム、および REST サービスは、次のような操作の自動化または無人実行に役立ちます。

繰り返しの多い操作でオペレーターのエラーを防止する。
オペレーターの通常の作業時間外に操作を行う。
テスト・サーバーまたは実動前サーバーと同じ設定で実動サーバーを構成する。

mfpadm Ant タスクと mfpadm プログラムは、REST サービスよりも使い方が簡単で、エラー・レポートも充実しています。 mfpadm プログラムよりも mfpadm Ant タスクが優れている点は、プラットフォームに依存しないことと、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 が設定された場合、スクリプトはこれを受け入れます。

mfpadm Ant タスクは、MobileFirst Server をインストールしたコンピューターとは別のコンピューターで使用できます。

ファイル product_install_dir/MobileFirstServer/mfp-ant-deployer.jar を目的のコンピューターにコピーします。
サポートされているバージョンの Apache Ant と Java ランタイム環境が、目的のコンピューターにインストールされていることを確認します。

mfpadm Ant タスクを使用するには、次の初期化コマンドを Ant スクリプトに追加します。

<taskdef resource="com/ibm/mfp/ant/deployers/antlib.xml">
  <classpath>
    <pathelement location="product_install_dir/MobileFirstServer/mfp-ant-deployer.jar"/>
  </classpath>
</taskdef>

defaults.properties によって実行される初期化は antlib.xml によっても暗黙的に実行されるため、同じ mfp-ant-deployer.jar ファイルを参照する他の初期化コマンドは冗長となります。冗長な初期化コマンドの例を以下に示します。

<taskdef resource="com/ibm/mfp/ant/defaults.properties">
  <classpath>
    <pathelement location="product_install_dir/MobileFirstServer/mfp-ant-deployer.jar"/>
  </classpath>
</taskdef>

MobileFirst Server インストーラーの実行について詳しくは、IBM インストール・マネージャーの実行 (Running IBM Installation Manager) を参照してください。

mfpadm Ant タスクの呼び出し

mfpadm Ant タスクとその関連コマンドを使用して、MobileFirst アプリケーションを管理することができます。次のようにして mfpadm Ant タスクを呼び出します。

<mfpadm url=... user=... password=...|passwordfile=... [secure=...]>
    some commands
</mfpadm>

属性

mfpadm Ant タスクには以下の属性があります。

属性	説明	必須	デフォルト
url	管理サービスの MobileFirst Web アプリケーションのベース URL	はい
secure	セキュリティー・リスクをともなう操作を回避するかどうか	いいえ	true
user	MobileFirst 管理サービスにアクセスするためのユーザー名	はい
password	ユーザーのパスワード	どちらか 1 つが必要
passwordfile	ユーザーのパスワードを含むファイル	どちらか 1 つが必要
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” 属性を指定することで、この検証を無効にすることができます。

出力文字セット

mfpadm Ant タスクの通常の出力は、現行のロケールのエンコード・フォーマットでエンコードされます。 Windows では、このエンコード・フォーマットは、いわゆる「ANSI コード・ページ」です。以下のような影響があります。

この文字セット以外の文字は、出力時に疑問符 (?) に変換されます。
出力が Windows コマンド・プロンプト・ウィンドウ (cmd.exe) に送られた場合、そのようなウィンドウでは、いわゆる「OEM コード・ページ」で文字がエンコードされていると仮定しているため、非 ASCII 文字は正しく表示されません。

この制約を回避するには、以下の手順を実行してください。

Windows 以外のオペレーティング・システムでは、エンコード・フォーマットが UTF-8 のロケールを使用します。これは、Red Hat Linux および macOS ではデフォルト・ロケールです。他の多くのオペレーティング・システムには、en_US.UTF-8 という名前のロケールがあります。
それ以外の場合は、output=”some file name” 属性を使用して、mfpadm コマンドの出力をファイルにリダイレクトします。

一般構成用のコマンド

mfpadm Ant タスクを呼び出すときに、IBM MobileFirst Server またはランタイムのグローバル構成にアクセスするさまざまなコマンドを含めることができます。

`show-global-config` コマンド

show-global-config コマンドは、グローバル構成を表示します。これには、以下の属性があります。

属性	説明	必須	デフォルト
output	出力ファイルの名前。	いいえ	該当なし
outputproperty	出力用の Ant プロパティーの名前。	いいえ	該当なし

例

<show-global-config/>

このコマンドは、グローバル構成 (GET) (Global Configuration (GET)) REST サービスに基づいています。

`show-user-config` コマンド

<adapter> エレメントおよび <app-version> エレメントの外にある show-user-config コマンドは、ランタイムのユーザー構成を表示します。これには、以下の属性があります。

属性	説明	必須	デフォルト
runtime	ランタイムの名前。	はい	使用不可
format	出力形式を指定します。 json または xml のいずれか。	はい	使用不可
output	出力を保存する先のファイルの名前。	いいえ	該当なし
outputproperty	出力を保存する先の Ant プロパティーの名前。	いいえ	該当なし

例

<show-user-config runtime="mfp" format="xml"/>

このコマンドは、ランタイム構成 (GET) REST サービスに基づいています。

`set-user-config` コマンド

<adapter> エレメントおよび <app-version> エレメントの外にある set-user-config コマンドは、ランタイムのユーザー構成を指定します。構成全体の設定用に、以下の属性があります。

属性	説明	必須	デフォルト
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"/>

このコマンドは、ランタイム構成 (PUT) (Runtime configuration (PUT)) REST サービスに基づいています。

`show-confidential-clients` コマンド

show-confidential-clients コマンドは、ランタイムにアクセスできる機密クライアントの構成を表示します。機密クライアントについて詳しくは、機密クライアント (Confidential clients) を参照してください。このコマンドには、以下の属性があります。

属性	説明	必須	デフォルト
runtime	ランタイムの名前。	はい	使用不可
format	出力形式を指定します。 json または xml のいずれか。	はい	使用不可
output	出力を保存する先のファイルの名前。	いいえ	該当なし
outputproperty	出力を保存する先の Ant プロパティーの名前。	いいえ	該当なし

例

<show-confidential-clients runtime="mfp" format="xml" output="clients.xml"/>

このコマンドは、機密クライアント (GET) REST サービスに基づいています。

`set-confidential-clients` コマンド

set-confidential-clients コマンドは、ランタイムにアクセスできる機密クライアントの構成を指定します。機密クライアントについて詳しくは、機密クライアント (Confidential clients) を参照してください。このコマンドには、以下の属性があります。

属性	説明	必須	デフォルト
runtime	ランタイムの名前。	はい	使用不可
file	新しい構成を含む JSON または XML ファイルの名前。	はい	使用不可

例

<set-confidential-clients runtime="mfp" file="clients.xml"/>

このコマンドは、機密クライアント (PUT) (Confidential Clients (PUT)) REST サービスに基づいています。

`set-confidential-clients-rule` コマンド

set-confidential-clients-rule コマンドは、ランタイムにアクセスできる機密クライアントの構成におけるルールを指定します。機密クライアントについて詳しくは、機密クライアント (Confidential clients) を参照してください。このコマンドには、以下の属性があります。

属性	説明	必須	デフォルト
runtime	ランタイムの名前。	はい	使用不可
id	ルールの ID。	はい	使用不可
displayName	ルールの表示名。	はい	使用不可
secret	ルールのシークレット。	はい	使用不可
allowedScope	ルールの適用範囲。スペースで区切られたトークンのリスト。	はい	使用不可

例

<set-confidential-clients-rule runtime="mfp" id="push" displayName="Push" secret="lOa74Wxs" allowedScope="**"/>

このコマンドは、機密クライアント (PUT) (Confidential Clients (PUT)) REST サービスに基づいています。

アダプター用のコマンド

mfpadm Ant タスクを呼び出すときに、アダプター用のさまざまなコマンドを含めることができます。

`list-adapters` コマンド

list-adapters コマンドは、指定されたランタイムにデプロイされたアダプターのリストを返します。以下の属性があります。

属性	説明	必須	デフォルト
runtime	ランタイムの名前。	はい	使用不可
output	出力ファイルの名前。	いいえ	該当なし
outputproperty	出力用の Ant プロパティーの名前。	いいえ	該当なし

例

<list-adapters runtime="mfp"/>

このコマンドは、Adapters (GET) REST サービスに基づいています。

`deploy-adapter` コマンド

deploy-adapter コマンドは、アダプターをランタイムにデプロイします。以下の属性があります。

属性	説明	必須	デフォルト
runtime	ランタイムの名前。	はい	使用不可
file	バイナリー・アダプター・ファイル (.adapter)。	はい	使用不可

例

<deploy-adapter runtime="mfp" file="MyAdapter.adapter"/>

このコマンドは、Adapter (POST) REST サービスに基づいています。

`show-adapter` コマンド

show-adapter コマンドは、アダプターに関する詳細を表示します。以下の属性があります。

属性	説明	必須	デフォルト
runtime	ランタイムの名前。	はい	使用不可
name	アダプターの名前。	はい	使用不可
output	出力ファイルの名前。	いいえ	該当なし
outputproperty	出力用の Ant プロパティーの名前。	いいえ	該当なし

例

<show-adapter runtime="mfp" name="MyAdapter"/>

このコマンドは、Adapter (GET) REST サービスに基づいています。

`delete-adapter` コマンド

delete-adapter コマンドは、アダプターをランタイムから削除 (アンデプロイ) します。以下の属性があります。

属性	説明	必須	デフォルト
runtime	ランタイムの名前。	はい	使用不可
name	アダプターの名前。	はい	使用不可

例

<delete-adapter runtime="mfp" name="MyAdapter"/>

このコマンドは、Adapter (DELETE) REST サービスに基づいています。

`adapter` コマンド・グループ

adapter コマンド・グループには以下の属性があります。

属性	説明	必須	デフォルト
runtime	ランタイムの名前。	はい	使用不可
name	アダプターの名前。	はい	使用不可

adapter コマンドは以下のエレメントをサポートします。

エレメント	説明	カウント
get-binary	バイナリー・データを取得します。	0..∞
show-user-config	ユーザー構成を表示します。	0..∞
set-user-config	ユーザー構成を指定します。	0..∞

`get-binary` コマンド

<adapter> エレメント内の get-binary コマンドは、バイナリー・アダプター・ファイルを返します。以下の属性があります。

属性	説明	必須	デフォルト
tofile	出力ファイルの名前。	はい	使用不可

例

<adapter runtime="mfp" name="MyAdapter">
  <get-binary tofile="/tmp/MyAdapter.adapter"/>
</adapter>

このコマンドは、Adapter (GET) REST サービスに基づいています。

`show-user-config` コマンド

<adapter> エレメント内の show-user-config コマンドは、アダプターのユーザー構成を表示します。以下の属性があります。

属性	説明	必須	デフォルト
format	出力形式を指定します。 json または xml のいずれか。	はい	使用不可
output	出力を保存する先のファイルの名前。	いいえ	該当なし
outputproperty	出力を保存する先の Ant プロパティーの名前。	いいえ	該当なし

例

<adapter runtime="mfp" name="MyAdapter">
  <show-user-config format="xml"/>
</adapter>

このコマンドは、アダプター構成 (GET) (Adapter Configuration (GET)) REST サービスに基づいています。

`set-user-config` コマンド

<adapter> エレメント内の set-user-config コマンドは、アダプターのユーザー構成を指定します。構成全体の設定用に、以下の属性があります。

属性	説明	必須	デフォルト
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>

このコマンドは、アプリケーション構成 (PUT) (Application Configuration (PUT)) REST サービスに基づいています。

アプリケーション用のコマンド

mfpadm Ant タスクを呼び出すときに、アプリケーション用のさまざまなコマンドを含めることができます。

`list-apps` コマンド

list-apps コマンドは、ランタイムにデプロイされたアプリケーションのリストを返します。以下の属性があります。

属性	説明	必須	デフォルト
runtime	ランタイムの名前。	はい使用不可
output	出力ファイルの名前。	いいえ該当なし
outputproperty	出力用の Ant プロパティーの名前。	いいえ	該当なし

例

<list-apps runtime="mfp"/>

このコマンドは、Applications (GET) REST サービスに基づいています。

`deploy-app` コマンド

deploy-app コマンドは、アプリケーション・バージョンをランタイムにデプロイします。以下の属性があります。

属性	説明	必須	デフォルト
runtime	ランタイムの名前。	はい	使用不可
file	アプリケーション記述子、JSON ファイル。	はい	使用不可

例

<deploy-app runtime="mfp" file="MyApp/application-descriptor.json"/>

このコマンドは、Application (POST) REST サービスに基づいています。

`show-app` コマンド

show-app コマンドは、ランタイムにデプロイされたアプリケーション・バージョンのリストを返します。以下の属性があります。

属性	説明	必須	デフォルト
runtime	ランタイムの名前。	はい	使用不可
name	アプリケーションの名前。	はい	使用不可
output	出力ファイルの名前。	いいえ	該当なし
outputproperty	出力用の Ant プロパティーの名前。	いいえ	該当なし

例

<show-app runtime="mfp" name="MyApp"/>

このコマンドは、Application (GET) REST サービスに基づいています。

`delete-app` コマンド

delete-app コマンドは、デプロイされていたすべての環境について、アプリケーションとそのすべてのアプリケーション・バージョンをランタイムから削除 (アンデプロイ) します。以下の属性があります。

属性	説明	必須	デフォルト
runtime	ランタイムの名前。	はい	使用不可
name	アプリケーションの名前。	はい	使用不可

例

<delete-app runtime="mfp" name="MyApp"/>

このコマンドは、アプリケーション・バージョン (DELETE) (Application Version (DELETE)) REST サービスに基づいています。

`show-app-version` コマンド

show-app-version コマンドは、ランタイムのアプリケーション・バージョンに関する詳細を表示します。以下の属性があります。

属性	説明	必須
runtime ランタイムの名前。	はい	使用不可
name アプリケーションの名前。	はい	使用不可
environment モバイル・プラットフォーム。	はい	使用不可
version アプリケーションのバージョン番号。	はい	使用不可

例

<show-app-version runtime="mfp" name="MyApp" environment="iphone" version="1.1"/>

このコマンドは、アプリケーション・バージョン (GET) (Application Version (GET)) REST サービスに基づいています。

`delete-app-version` コマンド

delete-app-version コマンドは、アプリケーション・バージョンをランタイムから削除 (アンデプロイ) します。以下の属性があります。

属性	説明	必須
runtime ランタイムの名前。	はい	使用不可
name アプリケーションの名前。	はい	使用不可
environment モバイル・プラットフォーム。	はい	使用不可
version アプリケーションのバージョン番号。	はい	使用不可

例

<delete-app-version runtime="mfp" name="MyApp" environment="iphone" version="1.1"/>

このコマンドは、アプリケーション・バージョン (DELETE) (Application Version (DELETE)) REST サービスに基づいています。

`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>

このコマンドは、アプリケーション・ライセンス構成 (GET) (Application license configuration (GET)) REST サービスに基づいています。

`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>

このコマンドは、アプリケーション・ライセンス構成 (POST) (Application License Configuration (POST)) REST サービスに基づいています。

`delete-license-config` コマンド

delete-license-config コマンドは、アプリケーションのトークン・ライセンス構成をリセットします。つまり、構成を初期状態に戻します。

例

<app-version runtime="mfp" name="MyApp" environment="iphone" version="1.1">
  <delete-license-config/>
</app-version>

このコマンドは、ライセンス構成 (DELETE) (License configuration (DELETE)) REST サービスに基づいています。

`app-version` コマンド・グループ

app-version コマンド・グループには以下の属性があります。

属性	説明	必須	デフォルト
runtime	ランタイムの名前。	はい	使用不可
name	アプリケーションの名前。	はい	使用不可
environment	モバイル・プラットフォーム。	はい	使用不可
version	アプリケーションのバージョン。	はい	使用不可

app-version コマンド・グループは、以下のエレメントをサポートしています。

エレメント	説明	カウント
get-descriptor	記述子を取得します。	0..
get-web-resources	Web リソースを取得します。	0..
set-web-resources	Web リソースを指定します。	0..
get-authenticity-data	認証データを取得します。	0..
set-authenticity-data	認証データを指定します。	0..
delete-authenticity-data	認証データを削除します。	0..
show-user-config	ユーザー構成を表示します。	0..
set-user-config	ユーザー構成を指定します。	0..

`get-descriptor` コマンド

<app-version> エレメント内の get-descriptor コマンドは、アプリケーションのバージョンのアプリケーション記述子を返します。以下の属性があります。

属性	説明	必須	デフォルト
output	出力を保存する先のファイルの名前。	いいえ	該当なし
outputproperty	出力を保存する先の Ant プロパティーの名前。	いいえ	該当なし

例

<app-version runtime="mfp" name="MyApp" environment="iphone" version="1.1">
  <get-descriptor output="/tmp/MyApp-application-descriptor.json"/>
</app-version>

このコマンドは、アプリケーション記述子 (GET) (Application Descriptor (GET)) REST サービスに基づいています。

`get-web-resources` コマンド

<app-version> エレメント内の get-web-resources コマンドは、アプリケーションのバージョンの Web リソースを .zip ファイルとして返します。以下の属性があります。

属性	説明	必須	デフォルト
tofile	出力ファイルの名前。	はい	使用不可

例

<app-version runtime="mfp" name="MyApp" environment="iphone" version="1.1">
  <get-web-resources tofile="/tmp/MyApp-web.zip"/>
</app-version>

このコマンドは、Web リソースの取得 (GET) REST サービスに基づいています。

`set-web-resources` コマンド

<app-version> エレメント内の set-web-resources コマンドは、アプリケーションのバージョンの Web リソースを指定します。以下の属性があります。

属性	説明	必須	デフォルト
file	入力ファイルの名前 (.zip ファイルでなければなりません)。	はい	使用不可

例

<app-version runtime="mfp" name="MyApp" environment="iphone" version="1.1">
  <set-web-resources file="/tmp/MyApp-web.zip"/>
</app-version>

このコマンドは、Web リソースのデプロイ (POST) (Deploy a web resource (POST)) REST サービスに基づいています。

`get-authenticity-data` コマンド

<app-version> エレメント内の get-authenticity-data コマンドは、アプリケーションのバージョンの認証データを返します。以下の属性があります。

属性	説明	必須	デフォルト
output	出力を保存する先のファイルの名前。	いいえ	該当なし
outputproperty	出力を保存する先の Ant プロパティーの名前。	いいえ	該当なし

例

<app-version runtime="mfp" name="MyApp" environment="iphone" version="1.1">
  <get-authenticity-data output="/tmp/MyApp.authenticity_data"/>
</app-version>

このコマンドは、ランタイム・リソースのエクスポート (GET) (Export runtime resources (GET)) REST サービスに基づいています。

`set-authenticity-data` コマンド

<app-version> エレメント内の set-authenticity-data コマンドは、アプリケーションのバージョンの認証データを指定します。以下の属性があります。

属性	説明	必須	デフォルト
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>

このコマンドは、アプリケーション認証データのデプロイ (POST) (Deploy Application Authenticity Data (POST)) REST サービスに基づいています。

`delete-authenticity-data` コマンド

<app-version> エレメント内の delete-authenticity-data コマンドは、アプリケーションのバージョンの認証データを削除します。属性はありません。

例

<app-version runtime="mfp" name="MyApp" environment="iphone" version="1.1">
  <delete-authenticity-data/>
</app-version>

このコマンドは、アプリケーション認証性 (DELETE) (Application Authenticity (DELETE) REST サービスに基づいています。

`show-user-config` コマンド

<app-version> エレメント内の show-user-config コマンドは、アプリケーションのバージョンのユーザー構成を表示します。以下の属性があります。

属性	説明	必須	デフォルト
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>

このコマンドは、アプリケーション構成 (GET) (Application Configuration (GET)) REST サービスに基づいています。

`set-user-config` コマンド

<app-version> エレメント内の set-user-config コマンドは、アプリケーションのバージョンのユーザー構成を指定します。構成全体の設定用に、以下の属性があります。

属性	説明	必須	デフォルト
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>

デバイス用のコマンド

mfpadm Ant タスクを呼び出すときに、デバイス用のさまざまなコマンドを含めることができます。

`list-devices` コマンド

list-devices コマンドは、ランタイムのアプリケーションと接触のあるデバイスのリストを返します。これには、以下の属性があります。

属性	説明	必須	デフォルト
runtime	ランタイムの名前。	はい	使用不可
query	検索対象の分かりやすい名前またはユーザー ID。このパラメーターには、検索対象のストリングを指定します。このストリングが含まれる (大/小文字を区別しないマッチングによって)、	分かりやすい名前またはユーザー ID を持つすべてのデバイスが返されます。	いいえ	該当なし
output	出力ファイルの名前。	いいえ	該当なし
outputproperty	出力用の Ant プロパティーの名前。	いいえ	該当なし

例

<list-devices runtime="mfp"/>

<list-devices runtime="mfp" query="john"/>

このコマンドは、Devices (GET) REST サービスに基づいています。

`remove-device` コマンド

remove-device コマンドは、ランタイムのアプリケーションと接触のあるデバイスに関するレコードを消去します。これには、以下の属性があります。

属性	説明	必須	デフォルト
runtime	ランタイムの名前。	はい	使用不可
id	固有のデバイス ID。	はい	使用不可

例

<remove-device runtime="mfp" id="496E974CCEDE86791CF9A8EF2E5145B6"/>

このコマンドは、Device (DELETE) REST サービスに基づいています。

`device` コマンド・グループ

device コマンド・グループには以下の属性があります。

属性	説明	必須	デフォルト
runtime	ランタイムの名前。	はい	使用不可
id	固有のデバイス 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>

このコマンドは、Device Status (PUT) REST サービスに基づいています。

`set-appstatus` コマンド

set-appstatus コマンドは、ランタイム内のアプリケーションに関して、デバイスの状況を変更します。これには、以下の属性があります。

属性	説明	必須	デフォルト
app	アプリケーションの名前。	はい	使用不可
status	新しい状況。	はい	使用不可

この状況の値は、以下のいずれかになります。

ENABLED
DISABLED

例

<device runtime="mfp" id="496E974CCEDE86791CF9A8EF2E5145B6">
  <set-appstatus app="MyApp" status="DISABLED"/>
</device>

このコマンドは、Device Application Status (PUT) REST サービスに基づいています。

トラブルシューティング用のコマンド

Ant タスク・コマンドを使用して、MobileFirst Server Web アプリケーションでの問題を調査することができます。

`show-info` コマンド

show-info コマンドは、ランタイムやデータベースにアクセスせずに返されることが可能な、MobileFirst 管理サービスに関する基本情報を表示します。このコマンドを使用して、MobileFirst 管理サービスが実行されているかどうかをテストします。これには、以下の属性があります。

属性	説明	必須	デフォルト
output	出力ファイルの名前。	いいえ	該当なし
outputproperty	出力用の Ant プロパティーの名前。	いいえ	該当なし

例

<show-info/>

`show-versions` コマンド

show-versions コマンドは、各種コンポーネントの MobileFirst バージョンを表示します。

mfpadmVersion: mfp-ant-deployer.jar ファイルが取得される MobileFirst Server の正確なバージョン番号。
productVersion: mfp-admin-service.war ファイルが取得される MobileFirst Server の正確なバージョン番号。
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"/>

このコマンドは、Runtimes (GET) REST サービスに基づいています。

`show-runtime` コマンド

show-runtime コマンドは、指定されたデプロイ済みのランタイムに関する情報を表示します。これには、以下の属性があります。

属性	説明	必須	デフォルト
runtime	ランタイムの名前。	はい	使用不可
output	出力ファイルの名前。	いいえ	該当なし
outputproperty	出力用の Ant プロパティーの名前。	いいえ	該当なし

例

<show-runtime runtime="mfp"/>

このコマンドは、Runtime (GET) REST サービスに基づいています。

`delete-runtime` コマンド

delete-runtime コマンドは、ランタイム (そのアプリケーションとアダプターを含む) をデータベースから削除します。ランタイムを削除できるのは、その Web アプリケーションが停止している場合のみです。コマンドには、以下の属性があります。

属性	説明	必須	デフォルト
runtime	ランタイムの名前。	はい	使用不可
condition	削除する条件。empty または always のいずれかです。注意: always オプションは危険です。	いいえ	該当なし

例

<delete-runtime runtime="mfp" condition="empty"/>

このコマンドは、Runtime (DELETE) REST サービスに基づいています。

`list-farm-members` コマンド

list-farm-members コマンドは、所定のランタイムがデプロイされているファーム・メンバー・サーバーのリストを返します。これには、以下の属性があります。

属性	説明	必須	デフォルト
runtime	ランタイムの名前。	はい	使用不可
output	出力ファイルの名前。	いいえ	該当なし
outputproperty	出力用の Ant プロパティーの名前。	いいえ	該当なし

例

<list-farm-members runtime="mfp"/>

このコマンドは、ファーム・トポロジー・メンバー (GET) (Farm topology members (GET)) REST サービスに基づきます。

`remove-farm-member` コマンド

remove-farm-member コマンドは、所定のランタイムがデプロイされているファーム・メンバーのリストからサーバーを削除します。サーバーが使用不可になったとき、または切断されたときに、このコマンドを使用します。コマンドには、以下の属性があります。

属性	説明	必須	デフォルト
runtime	ランタイムの名前。	はい	使用不可
serverId	サーバーの ID。	はい	該当なし
force	ファーム・メンバーが使用可能の場合、または接続されている場合でも、ファーム・メンバーの削除を強制します。	いいえ	false

例

<remove-farm-member runtime="mfp" serverId="srvlx15"/>

このコマンドは、ファーム・トポロジー・メンバー (Farm topology members (DELETE)) REST サービスに基づきます。

▲

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.

Last modified on February 26, 2020

Ant を介したアプリケーション管理

概説

ジャンプ先

他の機能との比較

前提条件

ジャンプ先

mfpadm Ant タスクの呼び出し

属性

エレメント

XML 形式

出力文字セット

一般構成用のコマンド

show-global-config コマンド

show-user-config コマンド

set-user-config コマンド

show-confidential-clients コマンド

set-confidential-clients コマンド

set-confidential-clients-rule コマンド

アダプター用のコマンド

list-adapters コマンド

deploy-adapter コマンド

show-adapter コマンド

delete-adapter コマンド

adapter コマンド・グループ

get-binary コマンド

show-user-config コマンド

set-user-config コマンド

アプリケーション用のコマンド

list-apps コマンド

deploy-app コマンド

show-app コマンド

delete-app コマンド

show-app-version コマンド

delete-app-version コマンド

app コマンド・グループ

show-license-config コマンド

set-license-config コマンド

delete-license-config コマンド

app-version コマンド・グループ

get-descriptor コマンド

get-web-resources コマンド

set-web-resources コマンド

get-authenticity-data コマンド

set-authenticity-data コマンド

delete-authenticity-data コマンド

show-user-config コマンド

set-user-config コマンド

デバイス用のコマンド

list-devices コマンド

remove-device コマンド

device コマンド・グループ

set-status コマンド

set-appstatus コマンド

トラブルシューティング用のコマンド

show-info コマンド

show-versions コマンド

show-diagnostics コマンド

unlock コマンド

list-runtimes コマンド

show-runtime コマンド

delete-runtime コマンド

list-farm-members コマンド

remove-farm-member コマンド

`show-global-config` コマンド

`show-user-config` コマンド

`set-user-config` コマンド

`show-confidential-clients` コマンド

`set-confidential-clients` コマンド

`set-confidential-clients-rule` コマンド

`list-adapters` コマンド

`deploy-adapter` コマンド

`show-adapter` コマンド

`delete-adapter` コマンド

`adapter` コマンド・グループ

`get-binary` コマンド

`show-user-config` コマンド

`set-user-config` コマンド

`list-apps` コマンド

`deploy-app` コマンド

`show-app` コマンド

`delete-app` コマンド

`show-app-version` コマンド

`delete-app-version` コマンド

`app` コマンド・グループ

`show-license-config` コマンド

`set-license-config` コマンド

`delete-license-config` コマンド

`app-version` コマンド・グループ

`get-descriptor` コマンド

`get-web-resources` コマンド

`set-web-resources` コマンド

`get-authenticity-data` コマンド

`set-authenticity-data` コマンド

`delete-authenticity-data` コマンド

`show-user-config` コマンド

`set-user-config` コマンド

`list-devices` コマンド

`remove-device` コマンド

`device` コマンド・グループ

`set-status` コマンド

`set-appstatus` コマンド

`show-info` コマンド

`show-versions` コマンド

`show-diagnostics` コマンド

`unlock` コマンド

`list-runtimes` コマンド

`show-runtime` コマンド

`delete-runtime` コマンド

`list-farm-members` コマンド

`remove-farm-member` コマンド