Заранее определенные макросы
Макросы предоставляют возможность добавить переменные данные (параметры конфигурации) в файл автоматической установки или послеустановочный скрипт. Lenovo XClarity Administrator предоставляет набор заранее определенных параметров, которые можно использовать.
Чтобы добавить заранее определенные макросы в файл автоматической установки или послеустановочный скрипт, добавьте в качестве префикса макроса predefined для заранее определенных макросов, разделите вложенные объекты с помощью точки и заключите имя макроса в символы «решетки» (#), например #predefined.globalSettings.ipAssignment#.
Значение для каждого заранее определенного макроса отличается в зависимости от экземпляра XClarity Administrator. Например, выбрав , можно задать режим назначения IP-адресов. После получения введенного пользователем значения во время развертывания ОС это значение представляется в заранее определенных параметрах конфигурации заранее определенным макросом #predefined.globalSettings.ipAssignment# и в экземпляре JSON-файла параметров конфигурации под именем объекта ipAssignment.
В следующей таблице перечислены заранее определенные макросы (параметры конфигурации), доступные в XClarity Administrator.
Имя макроса | Тип | Описание | ||||
---|---|---|---|---|---|---|
predefined | Объект | Сведения обо всех заранее определенных параметрах развертывания ОС | ||||
globalSettings | Объект | Сведения о глобальных параметрах развертывания ОС. | ||||
credentials | Массив объектов | Сведения об учетных данных пользователей | ||||
name | Строка | |||||
type | Строка | Тип операционной системы. Может иметь одно из следующих значений.
| ||||
ipAssignment | Строка | Режим задания сетевых параметров хоста при развертывании операционной системы. Может иметь одно из следующих значений.
| ||||
isVLANMode | Строка | Указывает, используется ли режим VLAN. Может иметь одно из следующих значений.
| ||||
hostPlatforms | Объект | Параметры развертывания с платформ хостов | ||||
licenseKey | Строка | Лицензионный ключ, который будет использоваться для Microsoft Windows и VMware ESXi. При отсутствии лицензионного ключа можно задать для этого поля значение null. | ||||
networkSettings | Массив | Сведения о сетевых параметрах | ||||
dns1 | Строка | Предпочитаемый сервер DNS для сервера хоста, который будет использоваться после развертывания операционной системы | ||||
dns2 | Строка | Альтернативный сервер DNS для сервера хоста, который будет использоваться после развертывания операционной системы | ||||
gateway | Строка | Шлюз сервера хоста, который будет использоваться после развертывания операционной системы. Этот параметр используется, если в глобальных параметрах развертывания ОС для сетевых параметров задан статический режим. Совет Чтобы определить режим IP, используйте | ||||
hostname | Строка | Имя хоста сервера хоста. Если имя хоста не указано, назначается имя хоста по умолчанию. | ||||
ipAddress | Строка | IP-адрес сервера хоста, который будет использоваться после развертывания операционной системы. Этот параметр используется, если в глобальных параметрах развертывания ОС для сетевых параметров задан статический режим. | ||||
mtu | Длинное целое | Максимальный передаваемый блок данных хоста, который будет использоваться после развертывания операционной системы. | ||||
prefixLength | Строка | Длина префикса IP-адреса хоста, которая будет использоваться после развертывания операционной системы. Этот параметр используется, если в глобальных параметрах развертывания ОС для сетевых параметров задан статический режим IPv6. | ||||
selectedMAC | Строка | MAC-адрес сервера хоста, к которому необходимо привязать IP-адрес. MAC-адрес имеет значение AUTO по умолчанию. Этот параметр автоматически обнаруживает порты Ethernet, которые можно настроить и использовать для развертывания. По умолчанию используется первый обнаруженный MAC-адрес (порт). Если обнаружено подключение на другом MAC-адресе, хост XClarity Administrator автоматически перезапускается, чтобы использовать новый обнаруженный MAC-адрес для развертывания и для параметра selectedMAC устанавливается значение недавно обнаруженного MAC-адреса. Режим VLAN поддерживается только для серверов, которые имеют MAC-адреса в инвентаре. Если AUTO — единственный MAC-адрес, доступный для сервера, использовать виртуальные локальные сети для развертывания операционных систем на этом сервере невозможно. Совет Чтобы получить MAC-адрес, используйте свойство ответа | ||||
subnetCIDRNumber | Целое число | Маска подсети хост-сервера, которая будет использоваться после развертывания операционной системы, в формате бесклассовой междоменной маршрутизации (CIDR). Этот параметр используется, если в глобальных параметрах развертывания ОС для сетевых параметров задан статический режим. Перед номером CIDR обычно стоит косая черта «/», а после — указывается IP-адрес. Например, IP-адрес 131.10.55.70 с маской подсети 255.0.0.0 (которая имеет 8 сетевых битов) будет представлен как 131.10.55.70 /8. Дополнительные сведения см. в разделе Веб-страница учебника по нотации CIDR. Совет Чтобы определить режим IP, используйте | ||||
subnetMask | Строка | Маска подсети сервера хоста, которая будет использоваться после развертывания операционной системы, в десятичном представлении адреса с точками (например, 255.0.0.0). Этот параметр используется, если в глобальных параметрах развертывания ОС для сетевых параметров задан статический режим. Совет Чтобы определить режим IP, используйте | ||||
vlanId | Строка | Идентификатор VLAN для добавления меток виртуальной локальной сети операционной системы. Этот параметр используется, только если включен режим VLAN. Чтобы определить, включен ли режим VLAN, используйте GET /osdeployment/globalSettings). Важное замечание Идентификатор VLAN следует указывать, только если в сети требуется метка VLAN. Использование меток VLAN может повлиять на маршрутизацию между операционной системой хоста и | ||||
selectedImage | Строка | Идентификатор профиля образа операционной системы для развертывания. Совет Чтобы получить идентификаторы профилей образов операционной системы, используйте свойство ответа | ||||
storageSettings | Массив | Предпочитаемое расположение хранилища, где требуется развернуть образы операционной системы. | ||||
targetDevice | Строка | Целевое устройство. Может иметь одно из следующих значений.
Прим. Для серверов ThinkServer этот параметр всегда имеет значение localdisk. | ||||
unattendFileId | Строка | Идентификатор файла автоматической установки, который будет использоваться в этом развертывании | ||||
— UUID | Строка | UUID сервера хоста, на котором будет развернута операционная система | ||||
imageSettings | Объект | Сведения о каждом образе ОС и профиле образа | ||||
name | Строка | Имя образа операционной системы | ||||
профиль | Строка | Имя профиля образа | ||||
otherSettings | Объект | Дополнительные параметры, относящиеся к выполняемым в настоящее время заданиям развертывания ОС | ||||
deployDataAndSoftwareLocation | Строка | Путь к извлеченным полезным данным программного обеспечения, пользовательским файлам и данным развертывания (например, сертификатам и журналам) | ||||
installRepoUrl | Строка | (Только SLES 15 и выше) URL-адрес для импортированного образа пакета Этот заранее определенный макрос можно использовать в пользовательском файле автоматической установки для media_url в дополнительном разделе, например:
| ||||
lxcaIp | Строка | IP-адрес экземпляра XClarity Administrator | ||||
lxcaRelease | Строка | Выпуск XClarity Administrator (например, 2.0.0) | ||||
jobId | Строка | Идентификатор выполняемого в настоящее время задания развертывания ОС | ||||
ntpServer | Строка | Сервер NTP, связанный с XClarity Administrator | ||||
statusSettings | Объект | Параметры состояния развертывания ОС | ||||
urlStatus | Строка | URL-адрес HTTPS (включая порт), который XClarity Administrator использует для сообщения о состоянии | ||||
certLocation | Строка | Папка, содержащая сертификаты, необходимые для доступа к веб-службе urlStatus из ОС хоста при первой загрузке | ||||
sdkLocation | Строка | Расположение программного обеспечения XClarity Administrator, которое предоставило скрипты поддержки и интерфейсы для доступа к XClarity Administrator. | ||||
timezone | Строка | Часовой пояс, заданный для XClarity Administrator (например, Америка/Нью Йорк) | ||||
unattendSettings | Объект | Параметры, используемые для заполнения файла автоматической установки. Эти значения относятся к версии XClarity Administrator. | ||||
networkConfig | Строка | (Только для ESXi и RHEL) Заранее определенное программным обеспечением XClarity Administrator содержимое для использования во время автоматической установки. Обеспечивает настройку сетевых параметров для операционной системы | ||||
preinstallConfig | Строка | Заранее определенное программным обеспечением XClarity Administrator содержимое для использования во время автоматической предварительной установки. Этот макрос содержит состояние до установки.
Внимание Настоятельно рекомендуется включить этот макрос в пользовательский файл автоматической установки. Макрос можно расположить в любом месте файла автоматической установки после строки 1 (после тега <xml>). | ||||
postinstallConfig | Строка | Заранее определенное программным обеспечением XClarity Administrator содержимое для использования после настройки и первой загрузки сервера. Этот макрос содержит состояние после установки.
Внимание Настоятельно рекомендуется включить этот макрос в пользовательский файл автоматической установки. Макрос можно расположить в любом месте файла автоматической установки после строки 1 (после тега <xml>). | ||||
reportWorkloadNotComplete | Строка | При наличии этого макроса макрос postinstallConfig не сообщает о состоянии «Установка ОС завершена (17)». Настраиваемый профиль должен сообщать о завершении. | ||||
storageConfig | Строка | (Только для ESXi и RHEL) Заранее определенное программным обеспечением XClarity Administrator содержимое для использования во время автоматической установки. Обеспечивает настройку параметров хранилища для операционной системы. |