跳至主要内容

預先定義的巨集

巨集讓您能夠將可變資料（配置設定）新增至自動安裝檔案或安裝後 Script。Lenovo XClarity Administrator 提供一組預先定義的配置設定以讓您使用。

若要將預先定義的巨集插入自動安裝檔案或安裝後 Script，請以「predefined」做為巨集的字首代表預先定義的巨集，使用句號分隔巢狀物件，然後用 # 字號括住巨集名稱，例如 #predefined.globalSettings.ipAssignment#。

每個預先定義的巨集其值取決於 XClarity Administrator 實例。例如，部署 OS 映像檔 > 廣域設定 > IP 指派欄位可讓您指定 IP 模式。在 OS 部署期間收集使用者輸入的值之後，此值將顯示於預先定義的巨集 #predefined.globalSettings.ipAssignment# 所預先定義的配置設定中，以及配置設定 JSON 檔案實例的 ipAssignment 物件名稱下。

下表列出 XClarity Administrator 中可用之預先定義的巨集（配置設定）。

巨集名稱類型說明
predefined物件所有預先定義的 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 的授權金鑰。如果您沒有授權金鑰，您可以將此欄位設定為空值。
  networkSettings陣列網路設定的相關資訊
   dns1字串部署作業系統後要使用之主機伺服器的偏好 DNS 伺服器
   dns2字串部署作業系統後要使用之主機伺服器的替代 DNS 伺服器
   閘道字串部署作業系統後要使用之主機伺服器的閘道。當網路設定在廣域 OS 部署設定中設定為靜態時，就會使用此選項。
提示
若要判斷 IP 模式，請使用 GET /osdeployment/globalSettings。
   主機名稱字串主機伺服器的主機名稱。如果未指定主機名稱，則會指派預設主機名稱。
   ipAddress字串部署作業系統後要使用之主機伺服器的 IP 位址。當網路設定在廣域 OS 部署設定中設定為靜態時，就會使用此選項。
   mtu長部署作業系統後要使用之主機的最大傳輸單位。
   prefixLength字串部署作業系統後要使用之主機 IP 位址的字首長度。當網路設定在廣域 OS 部署設定中設定為靜態 IPv6 時，就會使用此選項。
   selectedMAC字串要連結 IP 位址之主機伺服器的 MAC 位址。

MAC 位址預設為 AUTO。此設定會自動偵測可配置並用於部署的乙太網路埠。依預設，將會使用第一個偵測到的 MAC 位址（埠）。如果在不同 MAC 位址上偵測到連線，XClarity Administrator 主機會自動重新啟動，以使用新偵測到的 MAC 位址來進行部署，且 selectedMAC 設定為新偵測到的 MAC 位址。

只有庫存中有 MAC 位址的伺服器才支援 VLAN 模式。如果伺服器唯一可用的 MAC 位址是 AUTO，則無法使用 VLAN 將作業系統部署至該伺服器。

提示
若要取得 MAC 位址，請使用 GET /hostPlatforms 中的 macaddress 回應屬性。
   subnetCIDRNumber整數部署作業系統後要使用之主機伺服器的子網路遮罩，採用無類別網域間路由 (CIDR) 格式。當網路設定在廣域 OS 部署設定中設定為靜態時，就會使用此選項。

CIDR 編號通常以斜線「/」開頭並位於 IP 位址之後。例如，子網路遮罩為 255.0.0.0（具有 8 個網路位元）的 IP 位址 131.10.55.70 將表示為 131.10.55.70 /8。如需相關資訊，請參閱 CIDR 表示法教學網頁。

提示
若要判斷 IP 模式，請使用 GET /osdeployment/globalSettings。
   subnetMask字串部署作業系統後要使用之主機伺服器的子網路遮罩，採用小數點十進位表示法（例如 255.0.0.0）。當網路設定在廣域 OS 部署設定中設定為靜態時，就會使用此選項。
提示
若要判斷 IP 模式，請使用 GET /osdeployment/globalSettings。
   vlanId字串作業系統 VLAN 標記的 VLAN ID。

此參數只有在啟用 VLAN 模式時才有效。若要判斷是否已啟用 VLAN 模式，請使用 GET /osdeployment/globalSettings。

重要
唯有需要 VLAN 標記才能在網路上運作時，才指定 VLAN ID。使用 VLAN 標記會影響主機作業系統與 XClarity Administrator 之間的網路路由能力。
  selectedImage字串要部署之作業系統映像檔的 Profile ID。
提示
若要取得作業系統映像檔 Profile ID，請使用 GET /hostPlatforms 中的 availableImages 回應屬性。
  storageSettings陣列您要部署作業系統映像檔的偏好儲存體位置
   targetDevice字串目標裝置。這可能是下列其中一個值。
  • localdisk。本端磁碟機。使用受管理伺服器中第一個列舉的本端磁碟機。
  • M.2drive：M.2 磁碟機。使用受管理伺服器中第一個列舉的 M.2 磁碟機。
  • usbdisk。Embedded USB Hypervisor。這個位置僅限 VMware ESXi 映像檔部署在受管理伺服器時適用。如果受管理的伺服器上已安裝兩個 Hypervisor 金鑰，則 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 目標，則可以選擇是否指定 IQN；如果未指定 IQN，則會為 OSDN 選取第一個偵測到的 iSCSI 目標。如果已指定，則進行完全符合比對。
註
若是 ThinkServer 伺服器，此值一律是「localdisk」。
  unattendFileId字串要搭配此部署使用的自動安裝檔案的 ID
  uuid字串要部署作業系統之主機伺服器的 UUID。
 imageSettings物件每個 OS 映像檔和映像檔 Profile 的相關資訊
  name字串作業系統映像檔名稱
  profile字串映像檔 Profile 名稱
 otherSettings物件與目前執行中 OS 部署工作相關的其他設定
  deployDataAndSoftwareLocation字串擷取的軟體負載、自訂檔案和部署資料（例如憑證和日誌）的路徑
  installRepoUrl字串（僅 SLES 15 和更新版本）：匯入的套件映像檔所在 URL
您可以在 add-on 區段將此預先定義的巨集用於自訂自動安裝檔案做為 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 的位置，提供協助程式 Script 和介面以存取 XClarity Administrator
  timezone字串針對 XClarity Administrator 設定的時區（例如：美洲/紐約）
 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 巨集便不會報告「作業系統安裝已完成」(17) 狀態。自訂 Profile 必須報告完成。
  storageConfig字串（僅限 ESXi 和 RHEL）XClarity Administrator 預先定義的內容，在安裝自動安裝檔案時使用。這會配置作業系統的儲存體設定。