メインコンテンツまでスキップ

事前定義済みマクロ

マクロによって、無人ファイルまたはポスト・インストール・スクリプトに、変数データ (構成設定) を追加できます。Lenovo XClarity Administrator では、一連の事前定義済み構成設定が用意されており、使用できます。

事前定義済みマクロ、無人ファイルまたはポスト・インストール・スクリプト・ファイルに挿入するには、事前定義済みマクロに「predefined」のプレフィックスを付け、ネストされたオブジェクトをピリオドで区切り、ハッシュ (#) 記号でマクロ名を囲みます (例: #predefined.globalSettings.ipAssignment#)。

事前定義された各マクロの値は、XClarity Administrator インスタンスに応じて異なります。たとえば、「OS イメージのデプロイ」 > 「共通設定」 > 「IP の割り当て」フィールドで、IP モードを指定できます。OS デプロイメント中にユーザー入力された値が収集された後、その値が事前定義済みマクロの #predefined.globalSettings.ipAssignment# によって事前定義済み構成設定に表示されます。また、および構成設定 JSON ファイルのインスタンスの ipAssignment オブジェクト名の下にも表示されます。

次の表は、XClarity Administrator で使用できる事前定義済みマクロ (構成設定) のリストです。

マクロ名タイプ説明
事前定義オブジェクトすべての事前定義 OS デプロイメント設定に関する情報
 globalSettingsオブジェクトグローバル OS デプロイメント設定に関する情報
  credentialsオブジェクトのアレイユーザー資格情報に関する情報
   nameストリング 
   typeストリングオペレーティング・システムのタイプ。これは以下のいずれかの値です。
  • ESXi
  • LINUX
  • WINDOWS
  ipAssignmentストリングオペレーティング・システムをデプロイするためのホスト・ネットワーク設定オプション。これは以下のいずれかの値です。
  • dhcpv4
  • staticv4
  • staticv6
  isVLANModeストリングVLAN モードが使用されているかどうかを示します。これは以下のいずれかの値です。
  • true。VLAN モードが使用されます。
  • false。VLAN モードは使用されていません。
 hostPlatformsオブジェクトホスト・プラットフォームからのデプロイメント設定
  licenseKeyストリングMicrosoft Windows または VMware ESXi で使用されるライセンス・キー。ライセンス・キーがない場合は、このフィールドを null に設定できます。
  networkSettingsアレイネットワーク設定に関する情報
   dns1ストリングオペレーティング・システムがデプロイされた後に使用されるホスト・サーバーの優先 DNS サーバー
   dns2ストリングオペレーティング・システムがデプロイされた後に使用されるホスト・サーバーの代替 DNS サーバー
   gatewayストリングオペレーティング・システムがデプロイされた後に使用されるホスト・サーバーのゲートウェイ。グローバル OS デプロイメント設定でネットワーク設定が静的に設定されている場合に使用されます。
ヒント
: IP モードを判別するには、GET /osdeployment/globalSettings を使用します。
   hostnameストリングホスト・サーバーのホスト名。ホスト名を指定しない場合は、デフォルトのホスト名が割り当てられます。
   ipAddressストリングオペレーティング・システムがデプロイされた後に使用されるホスト・サーバーの IP アドレス。グローバル OS デプロイメント設定でネットワーク設定が静的に設定されている場合に使用されます。
   mtuLongオペレーティング・システムがデプロイされた後に使用されるホストの最大転送単位。
   prefixLengthストリングオペレーティング・システムがデプロイされた後に使用されるホスト IP アドレスのプレフィックスの長さ。グローバル OS デプロイメント設定でネットワーク設定が静的 IPv6 に設定されている場合に使用されます。
   selectedMACストリングIP アドレスがバインドされるホスト・サーバーの MAC アドレス。

MAC アドレスはデフォルトで「自動」に設定されています。この設定は、デプロイメント用に構成して使用できるイーサネット・ポートを自動的に検出します。検出された最初の MAC アドレス (ポート) が、デフォルトで使用されます。別の MAC アドレスとの接続が検出された場合は、XClarity Administrator ホストが自動的に再起動され、新しく検出された MAC アドレスをデプロイメントに使用します、および selectedMAC は新たに検出された MAC アドレスに設定されます。

VLAN モードは、インベントリー内に MAC アドレスがあるサーバーでのみサポートされます。AUTO がそのサーバーで唯一の MAC アドレスである場合、そのサーバーへのオペレーティング・システムのデプロイに VLAN を使用することはできません。

ヒント
MAC アドレスを取得するには、GET /hostPlatforms の macaddress 応答プロパティを使用します。
   subnetCIDRNumber整数オペレーティング・システムのデプロイ後に使用されるホスト・サーバーのサブネット・マスク (Classless Inter-Domain Routing (CIDR) 形式)。グローバル OS デプロイメント設定でネットワーク設定が静的に設定されている場合に使用されます。

CIDR 番号は、通常はスラッシュ (/) で始まり、IP アドレスに従っています。たとえば、サブネット・マスク (8 つのネットワーク・ビットを持つ) の 255.0.0.0 の 131.10.55.70 の IP アドレスは、131.10.55.70 /8 となります。詳しくは、CIDR 表記のチュートリアル Web ページ を参照してください。

ヒント
: IP モードを判別するには、GET /osdeployment/globalSettings を使用します。
   subnetMaskストリングドット数値記法でのオペレーティング・システムのデプロイ後に使用されるホスト・サーバーのサブネット・マスク (例: 255.0.0.0)。グローバル OS デプロイメント設定でネットワーク設定が静的に設定されている場合に使用されます。
ヒント
: IP モードを判別するには、GET /osdeployment/globalSettings を使用します。
   vlanIdストリングオペレーティング・システム VLAN タグ付けの VLAN ID。

このパラメーターは VLAN モードが有効の場合にのみ有効です。VLAN モードが有効になっているかどうかを確認するには、XClarity Administrator オンライン・ドキュメントの GET /osdeployment/globalSettings)。

重要
VLAN タグがネットワーク上で機能するために必要な場合のみ VLAN ID を指定します。VLAN タグを使用すると、ホスト・オペレーティング・システムと XClarity Administrator の間のネットワーク・ルーティング可能性に影響を与えることがあります。
  selectedImageストリングデプロイするオペレーティング・システム・イメージのプロファイル ID。
ヒント
オペレーティング・システム・イメージのプロファイル ID を取得するには、GET /hostPlatforms の availableImages 応答プロパティを使用します。
  storageSettingsアレイオペレーティング・システム・イメージをデプロイする優先格納場所
   targetDeviceストリングターゲット・デバイス。これは以下のいずれかの値です。
  • ローカル・ディスク。ローカル・ディスク・ドライブ。管理対象サーバーで最初に列挙されたローカル・ディスク・ドライブが使用されます。
  • M.2 ドライブ。M.2 ドライブ。管理対象サーバーで最初に列挙された M.2 ドライブが使用されます。
  • USB ディスク。埋め込み USB ハイパーバイザー。この場所は、VMware ESXi イメージが管理対象サーバーにデプロイされている場合にのみ適用できます。2 つのハイパーバイザー・キーが管理対象サーバーにインストールされている場合、VMware インストーラーは、最初に列挙されているキーをデプロイ時に選択します。
  • lunpluswwn=LUN@WWN。FC SAN ストレージ (例: lunpluswwn=2@50:05:07:68:05:0c:09:bb)。
  • lunplusiqn=LUN@IQN. iSCSI SAN ストレージ (例: lunplusiqn=0@iqn.1990-01.com.lenovo:tgt1)。iSCSI ターゲットが 1 つしか構成されていない場合は、IQN の指定はオプションです。IQN が指定されていない場合、最初に検出された iSCSI ターゲットが OSDN に対して選択されます。指定されている場合、完全一致が作成されます。
注
ThinkServer サーバーの場合、この値は常に「localdisk」です。
  unattendFileIdストリングこのデプロイメントで使用する無人ファイルの ID
  UUIDストリングオペレーティング・システムのデプロイ先となるホスト・サーバーの UUID
 imageSettingsオブジェクト各 OS イメージとイメージ・プロファイルに関する情報
  nameストリングオペレーティング・システム・イメージ名
  profileストリングイメージ・プロファイル名
 otherSettingsオブジェクト現在実行中の OS デプロイメント・ジョブに関連する追加設定
  deployDataAndSoftwareLocationストリング展開されたソフトウェア・ペイロード、カスタム・ファイル、およびデプロイメント・データ (証明書やログなど) へのパス
  installRepoUrlストリング(SLES 15 以降のみ) インポート済みパッケージ イメージの URL
アドオン・セクションの media_url のカスタム無人で、この事前定義済みマクロを使用できます。例:
<add-on>
   <add_on_products config:type="list">
      <listentry>
         <media_url>#predefined.otherSettings.installRepoUrl#
         </media_url>
         <product>sle-module-basesystem</product>
         <product_dir>/Module-Basesystem</product_dir>
      </listentry>
   </add_on_products>
</add-on>
  lxcaIpストリングXClarity Administrator インスタンスの IP アドレス
  lxcaReleaseストリングXClarity Administrator リリース (例: 2.0.0)
  jobIdストリング現在実行中の OS デプロイメント・ジョブの ID
  ntpServerストリングXClarity Administrator に関連する NTP サーバー
  statusSettingsオブジェクトOS デプロイメント・ステータスの設定
   urlStatusストリングXClarity Administrator がステータスを報告する HTTPS URL (ポートを含む)
   certLocationストリング初回ブートでホスト OS から urlStatus Web サービスにアクセスするために必要な証明書が含まれるフォルダー
   sdkLocationストリングXClarity Administrator が提供するヘルパー・スクリプトおよび XClarity Administrator にアクセスするインターフェースの場所
  timezoneストリングXClarity Administrator に対して設定されたタイム・ゾーン (たとえば、America/New_York など)
 unattendSettingsオブジェクト無人ファイルを作成するために使用する設定。これらの値は、XClarity Administrator のバージョンに固有です
  networkConfigストリング(ESXi および RHEL のみ) 無人インストール時間に使用される XClarity Administrator の事前定義済みのコンテンツ。これにより、オペレーティング・システムのネットワーク設定が構成されます。
  preinstallConfigストリングプレインストール無人時間に使用される XClarity Administrator によって事前定義済みのコンテンツ。これには、プレインストールのステータスが含まれます。

  • ESXi および RHEL の場合は、%pre 初期インストール・スクリプト・フックが使用されます。

  • SLES の場合は、<scripts> 初期インストール・スクリプト・フックが使用されます。

重要
このマクロをカスタム無人ファイルに含めることを強くお勧めします。無人ファイルの行 1 の後ろ (<xml> タグの後ろ) の任意の場所にマクロを配置できます。
  postinstallConfigストリングサーバーが構成され初めてブートされた後に使用する XClarity Administrator の事前定義済みコンテンツ。これには、ポスト・インストールのステータスが含まれます。

  • ESXi および RHEL の場合は、%post ポスト・インストール・スクリプト・フックが使用されます。

  • SLES の場合は、<scripts> ポスト・インストール・スクリプト・フックが使用されます。

  • Windows の場合、「専門設定」セクションが使用されます。

重要
このマクロをカスタム無人ファイルに含めることを強くお勧めします。無人ファイルの行 1 の後ろ (<xml> タグの後ろ) の任意の場所にマクロを配置できます。
  reportWorkloadNotCompleteストリングこのマクロが存在している場合、postinstallConfig マクロは「OS インストールが完了しました (17)」ステータスを報告しません。カスタム・プロファイルでは完了を報告する必要があります。
  storageConfigストリング(ESXi および RHEL のみ) 無人インストール時間に使用される XClarity Administrator の事前定義済みのコンテンツ。これにより、オペレーティング・システムのストレージ設定が構成されます。