> ユーザー・ガイド > WDTツール > Model Help Tool

Model Help Tool

Model Help Toolは、ドメイン・モデルのセクションおよびフォルダに有効なフォルダおよび属性に関する情報を提供します。これは、新しいドメイン・モデルを作成したり、検出されたモデルを含む既存のモデルを拡張する場合に便利です。

Model Help Toolを使用する簡単な例を次に示します:

$ weblogic-deploy/bin/modelHelp.sh -oracle_home /tmp/oracle resources:/JDBCSystemResource

この結果、次のように出力されます。

Attributes and sub-folders for resources:/JDBCSystemResource

resources:
    JDBCSystemResource:
        'JDBC-1':
            CompatibilityName:       # string            *
            DeploymentOrder:         # integer           (default=100) *
            DeploymentPrincipalName: # string            *
            DescriptorFileName:      # string            *
            ModuleType:              # string            *
            Notes:                   # string            *
            SourcePath:              # string            *
            Target:                  # delimited_string  *

            JdbcResource:
                # see /JDBCSystemResource/JdbcResource

            SubDeployment:
                'SubDeployment-1':
                    # see /JDBCSystemResource/SubDeployment


This bean defines a system-level JDBC resource.  It links a separate
descriptor that specifies the definition.

この出力にはいくつかの重要な部分があります。

フォルダの属性のリスト
サブフォルダのリスト
MBeanの説明

次の3つのセクションでは、これらのそれぞれについて詳しく説明します。

属性

サンプル出力は、モデルのresourcesセクションにあるJDBCSystemResourceフォルダで使用可能な8つの属性と2つのサブフォルダを示しています。各属性には、追加する値のタイプを示すコメントが含まれます。属性の横にあるアスタリスク( *)は、デフォルト値、有効な範囲、説明など、使用可能な追加情報があることを示します。この追加情報にアクセスするには、パスの末尾に属性名を追加し、Model Help Toolを再度起動します。

$ weblogic-deploy/bin/modelHelp.sh -oracle_home /tmp/oracle /JDBCSystemResource/DeploymentOrder

Attributes and sub-folders for resources:/JDBCSystemResource/DeploymentOrder

resources:
    JDBCSystemResource:
        JDBC-1:
            DeploymentOrder: # integer

Default=100

An integer value that indicates when this unit is deployed, relative 
to other deployable units on a server, during startup. 
 Units with lower values are deployed before those with higher 
values.

Sub-folders

この例のSubDeploymentなど、複数のインスタンスをサポートするフォルダは、'SubDeployment-1'などの導出名とともに表示されます。各サブフォルダには、そのサブフォルダに関する追加情報を表示するために使用できるモデル・パスを含むコメントが含まれています。たとえば、'SubDeployment-1'の属性とサブフォルダを決定するには、Model Help Toolをコメントからのモデル・パスで再起動できます:

$ weblogic-deploy/bin/modelHelp.sh -oracle_home /tmp/oracle /JDBCSystemResource/SubDeployment

Attributes and sub-folders for resources:/JDBCSystemResource/SubDeployment

resources:
    JDBCSystemResource:
        JDBC-1:
            SubDeployment:
                SubDeployment-1:
                    CompatibilityName: # string            *
                    ModuleType:        # string            *
                    Notes:             # string            *
                    Target:            # delimited_string  *

This bean represents an individually targetable entity within 
a deployment package, which is deployable on WLS. This includes 
: 
 Modules in an EAR 
 
 JMS resources within a app scoped JMS module in an EAR

/JDBCSystemResource/SubDeploymentパスでは、先頭のresources:要素は省略されますが、Model Help Toolではどのフォルダがリクエストされているかを判断できるため、引き続き機能します。

MBeanの説明

出力の下部にあるテキストは、WebLogic Server MBeanの説明から直接取得されます。このテキストはMBeanによって異なり、一部のMBeansには他のテキストよりも有用な情報があります。

パス・パターン

path引数には、モデルのロケーションを指定する方法が多数あります。いくつか例を挙げます。

`top`

最上位レベルのモデル・セクション(topology、resourcesなど)をすべてリストします。

$ weblogic-deploy/bin/modelHelp.sh -oracle_home /tmp/oracle top

Attributes and sub-folders for top:/

domainInfo:
# see domainInfo:

topology:
# see topology:

resources:
# see resources:

appDeployments:
# see appDeployments:

kubernetes:
# see kubernetes:

verrazzano:
# see verrazzano:

セクション名

topology、resourcesなどのセクション内の属性およびフォルダをリストします。

$ weblogic-deploy/bin/modelHelp.sh -oracle_home /tmp/oracle appDeployments

Attributes and sub-folders for appDeployments:/

appDeployments:

  Application:
    App-1:
    # see /Application

  Library:
    Lib-1:
    # see /Library

フォルダ

フォルダ内のすべての属性およびフォルダをリストします。前述のように、フォルダへのパスには、最上位レベルのセクション名を含めることも除外することもできます。セクションがフォルダに指定されていない場合、そのセクションは導出され、出力テキストに含まれます。たとえば、resources:/JDBCSystemResource/JdbcResourceと/JDBCSystemResource/JdbcResourceは同等であり、同じ出力が生成されます。

$ weblogic-deploy/bin/modelHelp.sh -oracle_home /tmp/oracle /JDBCSystemResource/JdbcResource

Attributes and sub-folders for resources:/JDBCSystemResource/JdbcResource

resources:
    JDBCSystemResource:
        JDBC-1:
            JdbcResource:
                Version: # string  *

                JDBCConnectionPoolParams:
                    # see /JDBCSystemResource/JdbcResource/JDBCConnectionPoolParams

                JDBCDataSourceParams:
                    # see /JDBCSystemResource/JdbcResource/JDBCDataSourceParams

                JDBCDriverParams:
                    # see /JDBCSystemResource/JdbcResource/JDBCDriverParams

                JDBCOracleParams:
                    # see /JDBCSystemResource/JdbcResource/JDBCOracleParams

                JDBCXAParams:
                    # see /JDBCSystemResource/JdbcResource/JDBCXAParams

The top of the JDBC data source bean tree. 
 JDBC data sources all have a JDBCDataSourceBean as their root 
bean (a bean with no parent).  The schema namespace that corresponds 
to this bean is "http://xmlns.oracle.com/weblogic/jdbc-data-source"

属性ヘルプ

フォルダ内の特定の属性のヘルプを表示するには、単にモデル・パスに追加します。フォルダのリストには、追加のヘルプ情報を含む属性行の末尾にアスタリスクが含まれることに注意してください。

$ weblogic-deploy/bin/modelHelp.sh -oracle_home /tmp/oracle topology:/Server/Log/StdoutSeverity

Attributes and sub-folders for topology:/Server/Log/StdoutSeverity

topology:
    Server:
        'Server-1':
            Log:
                StdoutSeverity: # string

Default=Notice
Legal values:
   'Trace'
   'Debug'
   'Info'
   'Warning'
   'Error'
   'Notice'
   'Critical'
   'Alert'
   'Emergency'
   'Off'


The minimum severity of log messages going to the standard out.
Messages with a lower severity than the specified value will
not be published to standard out.

出力オプション

モデル・パスの出力テキストを制御するために使用できるコマンドライン・オプションがいくつかあります。これらのオプションは一度に1つのみを使用します。出力オプションが指定されていない場合、指定したパスの属性および即時サブフォルダがリストされます。

パスtopを使用して最上位セクションをリストする場合、出力オプションは無視されます。

`-attributes_only`

このオプションでは、指定したパスの属性のみがリストされます。

`-folders_only`

このオプションは、指定されたパスの直近のサブフォルダのみを表示します。

`-recursive`

このオプションは、指定されたパス内のすべてのサブフォルダを再帰的にリストします。属性がリストされていません。

$ weblogic-deploy/bin/modelHelp.sh -oracle_home /tmp/oracle -recursive resources:/JDBCSystemResource

Recursive sub-folders only for resources:/JDBCSystemResource

resources:
    JDBCSystemResource:
        'JDBC-1':
            JdbcResource:
                JDBCConnectionPoolParams:
                JDBCDataSourceParams:
                JDBCDriverParams:
                    Properties:
                        'Properties-1':
                JDBCOracleParams:
                JDBCXAParams:
            SubDeployment:
                'SubDeployment-1':

対話型オプション

ディレクトリ・スタイル構文を使用してモデル・パスを検索するための対話型コマンドラインにアクセスするには、コマンドラインからモデル・パスを省略します。

$ modelHelp.sh -oracle_home /tmp/oracle

Model Help running in interactive mode.  Type help for help.

Starting at location top

[top] --> help

Commands:

  ls                      - List contents of current location
  ls [path]               - List contents of specified location
  top, cd, cd /, cd top   - Change to the top-level location
  cd [path]               - Change to the specified location
  cat [path]              - Show details for the specified attribute location
  history                 - Show the history of visited locations
  exit                    - Exit interactive mode and the tool

  [path] Examples:
    x/y/z               - Relative path from the current location
    ../../a             - Relative path from the current location
    section[:[/a/b/c]]  - Absolute path to section and location, if specified
    /a[/b[/c]]          - Find the section that contains the specified folder

Sections:

  domainInfo, topology, resources, appDeployments, kubernetes, verrazzano

Examples:

  cd topology
  cd topology:/Server/Log/StdoutSeverity
  cd /Server/Log/StdoutSeverity
  cd ../../../ServerTemplate/DynamicServers


[top] -->

環境変数

次の環境変数を設定できます。

JAVA_HOME JDKのロケーション。これは有効なJava 7以降のJDKである必要があります。
WLSDEPLOY_PROPERTIES Javaに渡されるシステム・プロパティ。

Model Help ToolではWLSTを使用せずにJythonを直接使用するため、JAVA_HOMEはコマンドの実行に使用されるJDKになります(WLSTを使用する他のツールとは異なり)。

`model_help`のパラメータ表

パラメータ	定義	デフォルト
`-attributes_only`	指定したモデル・パスの属性のみをリストします。
`-folders_only`	指定したモデル・パスのフォルダのみをリストします。
`-oracle_home`	Oracle WebLogicインストールのホーム・ディレクトリ。 `ORACLE_HOME`環境変数が設定されていない場合は必須です。
`-recursive`	指定したモデル・パスのフォルダのみをリストし、そのパスの下にフォルダを再帰的に含めます。
`-target <target>`	`wko`などのターゲット・プラットフォーム(デフォルト)。これにより、`kubernetes`および`verrazzano`セクションの構造が決まります。ノート: Verrazzanoサポートは、WDT 4.0.0で非推奨になりました。
`-target_mode <mode>`	別名のロードに使用するWLSTモード。モードは、`online`または`offline`(デフォルト)です。
`<model_path>`	調査対象のモデル要素のパス。形式は`[^<section^>:][/^<folder^>]...`です。対話型モードで開始するには、この引数を省略します。

Model Help Tool

属性

Sub-folders

MBeanの説明

パス・パターン

top

セクション名

フォルダ

属性ヘルプ

出力オプション

-attributes_only

-folders_only

-recursive

対話型オプション

環境変数

model_helpのパラメータ表

`top`

`-attributes_only`

`-folders_only`

`-recursive`

`model_help`のパラメータ表