streamtool lstag
streamtool lstag コマンドは、ドメインのタグをリストします。
使用法
lstag .- --fmt--format-spec-. >>-+-----------------------+--+---------------------+-----------> '-+- -d----------+--did-' '-+- -s------+--------' '- --domain-id-' '- --short-' >--+-----------------+--+-------------------+-------------------> '- --trace--level-' '-+- -U-----+--user-' '- --User-' >--+-----------------------+--+-------------+-------------------> '-+- -v--------+--level-' '- --xheaders-' '- --verbose-' >--| 非対話式ツール・オプション |--+-------------+-------------->< '-tag-pattern-' 非対話式ツール・オプション (1) |--------+-----------------------------+------------------------| +- --embeddedzk---------------+ | .-,---------. | | V | | '- --zkconnect----host:port-+-'
- 非対話式ツール・オプションは、対話式 streamtool インターフェースではサポートされません。
権限
構成ドメイン・オブジェクトに対する読み取り権限を持っている必要があります。デフォルトで、DomainAdministrator ロールと DomainUser ロールはこの権限を持っています。アクセス制御リストについて詳しくは、streamtool getdomainacl を参照してください。
説明
タグは、物理的特性または論理的使用法が異なるリソースを区別および識別するためのメカニズムです。リソースは任意の数のタグを持つことができます。 タグは、大/小文字の区別がある、文字を含むストリングです。文字の後には、オプションで英数字または下線文字が指定されます。
- application
- リソースが IBM Streams のアプリケーションを実行できることを指定します。
- audit
- リソースがロギング・サービスを実行できることを指定します。
- authentication
- リソースが認証および許可サービスを実行できることを指定します。
- jmx
- リソースが 管理 API サービスを実行できることを指定します。
- management
- リソースが IBM Streams ドメインおよびインスタンスのすべての管理サービスを実行できることを指定します。
- sws
- リソースが Web 管理サービスを実行できることを指定します。
- view
- リソースがビュー・サービスを実行できることを指定します。
streamtool lstag コマンドを実行する際にタグ・パターンを指定しないと、ドメインのすべてのタグがリストされます。
tag-pattern のシンプルなタグ名 (例えば、'mytag1') を指定すると、コマンドは完全一致のみを返します。
- '*': ゼロ個以上の文字に一致します。
- '?': 1 個以上の文字に一致します。
シェルに特殊文字を解釈および拡張させないように注意してください。例えば、いずれかのワイルドカード文字を使用するタグ・パターンのまわりには引用符を使用してください。
タグ・パターンを指定したが、一致するタグが検出されない場合、コマンドは非ゼロの終了コードで終了します。
オプションおよび引数
- -d, --domain-id did
ドメイン ID を指定します。
このオプションを指定しないと、IBM Streams は、STREAMS_DOMAIN_ID 環境変数に設定されているドメイン・ネームを使用します。デフォルトでは、そのドメイン・ネームは StreamsDomain です。 対話式 streamtool インターフェースを使用している場合は、現行の streamtool セッションのアクティブ・ドメインの名前が使用されます。そうでない場合は、ドメイン・ネームの入力を求めるプロンプトが出されます。
現行 streamtool セッションのアクティブなドメインは、-d または --domain-id オプションを指定して streamtool コマンドが正常に実行されるたびに設定されます。 あるいは、対話式インターフェースで streamtool domain コマンドを実行できます。
- --embeddedzk
ZooKeeper の組み込みコピーを使用することを指定します。対話式 streamtool インターフェース内では、このオプションはサポートされません。
対話式 streamtool インターフェースを使用しておらず、このオプションまたは --zkconnect オプションのいずれも指定していない場合、IBM Streams は、アクティブ・ドメインまたは --domain-id オプションに指定されているドメインに関連付けられた ZooKeeper 接続を使用します。IBM Streams は、ドメインに関するキャッシュ情報を使用して、どの接続がドメインにマップされているかを判別します。このシナリオでは、ドメイン ID が IBM Streams 構成キャッシュ内で固有でない場合、コマンドは失敗します。
- --fmt format-spec
表示フォーマットを指定します。コマンドでは、次の値がサポートされます。
- %Mf: 複数行レコード・フォーマット。フィールドごとに 1 行。
- %Nf: 名前が前に付加されたフィールドの表のフォーマット。タグごとに 1 行。
- %Tf: 標準表フォーマット (デフォルト)。タグごとに 1 行。
- -h, --help
コマンド構文を表示することを指定します。
- -s, --short
情報の短縮リストを返すことを指定します。具体的には、コマンドは、タグ名のみを返します。
- tag-pattern
コマンドがタグをフィルターに掛けるために使用するパターンを指定します。
- --trace level
トレース設定を指定します。以下の有効なレベルは、詳細度が低い順にリストしています。つまり、リスト内の最初のレベルで、最小量の情報が生成されます。
- off
- error
- warn
- info
- debug
- trace
- -U, --User userid
コマンドを実行する権限を備えた IBM Streams ユーザー ID を指定します。
- -v,--verbose level
より詳細なコマンド出力を提供することを指定します。冗長レベルは 0-3 です。ここで、0 は、詳細なレポートを無効にします。値が増すにしたがって、より詳細な出力が提供されます。
- --xheaders
レポートから見出しを除外することを指定します。
- --zkconnect host:port
構成されている ZooKeeper サーバーを指定する、1 つ以上のホストとポートのペアの名前。 対話式 streamtool インターフェース内では、このオプションはサポートされません。
対話式 streamtool インターフェースを使用しておらず、このオプションを指定していない場合、IBM Streams は、以下の使用を試行します。- --embeddedzk オプション
- STREAMS_ZKCONNECT 環境変数の値
- 現行ドメインに関するキャッシュ情報から得られた ZooKeeper 接続ストリング。
例
[streamtool <bsmith@StreamsDomain.StreamsInstance>] lstag --fmt %Mf manage*
=================================================
Domain: StreamsDomain
=================================================
Tag : management
ResourceType: streams
Description : A management resource is one that can be
used to run the InfoSphere Streams management services.
=================================================