预定义宏

可使用宏向无人参与文件或安装后脚本中添加变量数据（配置设置）。Lenovo XClarity Administrator 提供了可以使用的一些预定义配置设置。

要向无人参与文件或安装后脚本中注入预定义宏，请在宏名称中添加“predefined”前缀、用句点分隔嵌套的对象并在宏名称前后添加井号（#），例如，#predefined.globalSettings.ipAssignment#。

各预定义宏的值因 XClarity Administrator 实例而异。例如，部署操作系统映像 > 全局设置 > IP 地址分配字段可用于指定 IP 模式。操作系统部署期间收集了用户输入的值后，将在预定义宏 #predefined.globalSettings.ipAssignment# 指定的预定义配置设置中和 ipAssignment Object 名称下的配置设置 JSON 文件实例中提供该值。

下表列出 XClarity Administrator 中提供的预定义宏（配置设置）。

宏名称				类型	描述
预定义				对象	有关所有预定义操作系统部署设置的信息
	globalSettings			对象	有关全局操作系统部署设置的信息
		credentials		对象数组	有关用户凭证的信息
			name	字符串
			类型	字符串	操作系统类型。此项可以是以下某个值。 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 服务器
			网关	字符串	部署操作系统后要使用的主机服务器的网关。这在全局操作系统部署设置中的网络设置设置为静态时使用。提示要确定 IP 模式，请使用 GET /osdeployment/globalSettings。
			主机名	字符串	主机服务器的主机名。如果不指定主机名，则分配默认主机名。
			ipAddress	字符串	部署操作系统后要使用的主机服务器的 IP 地址。这在全局操作系统部署设置中的网络设置设置为静态时使用。
			mtu	长整数	部署操作系统后要使用的最大传输单元。
			prefixLength	字符串	部署操作系统后要使用的主机 IP 地址的前缀长度。这在全局操作系统部署设置中的网络设置设置为静态 IPv6 时使用。
			selectedMAC	字符串	IP 地址要绑定到的主机服务器的 MAC 地址。默认情况下，MAC 地址设置为 AUTO。此设置会自动检测可配置和用于进行部署的以太网端口。默认情况下使用检测到的第一个 MAC 地址（端口）。如果在另一个不同的 MAC 地址检测到连接，则 XClarity Administrator 主机将自动重新启动以使用新检测到的 MAC 地址进行部署，且 selectedMAC 设置为新检测到 MAC 地址。仅当服务器在其清单中有 MAC 地址时才支持 VLAN 模式。如果服务器的 MAC 地址只有“AUTO”，则不能使用 VLAN 将操作系统部署到该服务器。提示要获取该 MAC 地址，请使用 GET /hostPlatforms 中的 macaddress 响应属性。
			subnetCIDRNumber	Integer	要在部署操作系统后使用的主机服务器的子网掩码，采用无类域间路由（CIDR）格式。这在全局操作系统部署设置中的网络设置设置为静态时使用。 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）。这在全局操作系统部署设置中的网络设置设置为静态时使用。提示要确定 IP 模式，请使用 GET /osdeployment/globalSettings。
			vlanId	字符串	用于操作系统 VLAN 标记的 VLAN ID。仅当启用了 VLAN 模式，此参数才有效。要确定是否启用了 VLAN 模式，请使用 GET /osdeployment/globalSettings。重要仅在要求 VLAN 标记在网络上发挥作用时指定 VLAN ID。使用 VLAN 标记可能会影响主机操作系统和 XClarity Administrator 之间能否进行网络路由。
		selectedImage		字符串	要部署的操作系统映像的 profile 标识。提示要获取操作系统 profile 标识，请使用 GET /hostPlatforms 中的 availableImages 响应属性。
		storageSettings		阵列	要用于部署操作系统映像的首选存储位置
			targetDevice	字符串	目标设备。此项可以是以下某个值。 localdisk。本地硬盘。将使用受管服务器中枚举的第一个本地硬盘。 M.2 驱动器。M.2 驱动器。将使用受管服务器中枚举的第一个 M.2 驱动器。 usbdisk。嵌入式 USB 虚拟机监控程序。仅在将 VMware ESXi 映像部署到受管服务器时此位置才适用。如果受管服务器上装有两个虚拟机监控程序 U 盘，则 VMware 安装程序选择所枚举的第一个 U 盘进行部署。 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		字符串	用于此部署的无人参与文件的标识
		UUID		字符串	操作系统将部署到的主机服务器的 UUID
	imageSettings			对象	有关各操作系统映像和映像 profile 的信息
		name		字符串	操作系统映像名称
		profile		字符串	映像 profile 名称
	otherSettings			对象	与当前正在运行的操作系统部署作业有关的其他设置
		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		字符串	当前正在运行的操作系统部署作业的标识
		ntpServer		字符串	与 XClarity Administrator 关联的 NTP 服务器
		statusSettings		对象	操作系统部署状态设置
			urlStatus	字符串	XClarity Administrator 用于报告状态的 HTTPS URL（包括端口）
			certLocation	字符串	其中包含首次引导时从主机操作系统访问 urlStatus Web 服务所需证书的文件夹
			sdkLocation	字符串	XClarity Administrator 为访问 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 预定义内容。这将配置操作系统的存储设置。

提供反馈