OS template macros

From ISPWiki
Jump to: navigation, search

Hierarchy: VMmanager KVM -> OS templates section
VMmanager Cloud -> OS templates section

This articles describes macros that can be used in the OS installation configuration files.

  • ($AFTER_INSTALL_SCRIPT_HTTPS) - URL to the script that starts through https upon installation. The path to the script is specified in the OsInstallAfterScript option.
  • ($AFTER_INSTALL_SCRIPT_HTTP) - URL to the script that starts through http upon installation. The path to the script is specified in the OsInstallAfterScript option.
  • ($AUTH_ID) — unique identifier of the current operaion.
  • ($CGI_IPMI_CHECK) — CGI that checks IPMI after configuration. It is used in the diagnostics templates.
  • ($CGI_MGR_URLv4) — CGI URL that uses IPv4-addresses.
  • ($CGI_MGR_URLv6) — CGI URL that uses IPv6-addresses.
  • ($CLEAR_HDD) — clear hard drives. This macro is used in diagnostics templates:
  • " " - do not run;
  • "yes" — run.

($FULL_HDD_CLEAR) — completely clear hard drives. This macro is used in diagnostics templates:

  • " " — do not run;
  • "yes" — run.

($DCIMINI_URL) — DCImini URL. It is specified for diagnostics, recovery and search templates.

  • ($FINISH) - URL that should be displayed upon installation.
  • ($FINISHv4) - URL that should be displayed upon installation through IPv4.
  • ($FINISHv6) - URL that should be displayed upon installation through IPv6.
  • ($GATEWAY) - default gateway
  • ($GATEWAYv4) - IPv4 default gateway
  • ($GATEWAY) - IPv6 default gateway

($HDD_RAID) — type of software RAID for configuration. This macro is used in templates that support RAID:

  • no_raid — do not configure RAID;
  • raid_0;
  • raid_1;
  • raid_5;
  • raid_10.
  • ($HOSTNAME) - host name
  • ($HTTPPROXY) — HTTP-proxy. This macro is used for package cache during OS deployment.
  • ($INITRD) — file system. This macro is used for PXE-boot.
  • ($IP) - IP-address
  • ($IPv4) - IPv4 address
  • ($IPv4ALIASES) — alias IPv4 addresses (separated by spaces).
  • ($IPv6) - IPv6 address
  • ($IPv6ALIASES) — alias IPv6 addresses (separated by spaces).
  • ($KERNEL) — Os kernel. This macro is used for PXE-boot.
  • ($LOCATIONIP) — location IP.
  • ($MGR_IP) — primary IP address of the control panel.
  • ($MGR_IPv4) — control panel IPv4.
  • ($MGR_IPv6) — control panel IPv6.
  • ($MGR_NAME) - control panel name.
  • vmmgr — VMmanager;
  • dcimgr — DCImanager.
  • ($MGR_URL) — control panel URL.

($MGR_URLv4) — control panel IPv4 URL.

($MGR_URLv6) — control panel IPv6 URL.

  • ($MGR_VERSION) - control panel version.
  • ($MIRROR) — OS repository mirror.
  • ($NAMESERVER) - primary DNS server
  • ($NAMESERVERS) — DNS-servers.
  • ($NAMESERVERv4) - IPv4 DNS server
  • ($NAMESERVERv6) - IPv6 DNS server
  • ($NETMASK) - primary IP network mask.

($NETMASK_SHORT) — network mask in the form of prefix.

($NETMASKv4) — IPv4 network mask.

($NETMASKv6) — IPv6 network mask.

($NFS) — path to the NFS-storage with files for the operation. This macro is specified for diagnostics, recovery, and search templates.

($NFSPATH) — full external path (including the IP address) to the NFS-storage with files for the operation.This macro is specified for diagnostics, recovery, and search templates.

($NO_ASKING_LABEL) — this macro is used in server search templates. The recovery mode will start in the found server. When accessing the server you can remotely specify the rack, unit, and server label that will be displayed in DCImanager. The value sent to the macros depends on the NoAskingLabel option in the control panel configuration file:

  • " " — request;
  • "yes" — do not request.

($NO_ASKING_SERIAL_NUMBER) — this macro is used in server search templates. The recovery mode will start in the found server. When accessing the server you can remotely specify the rack, unit, serial number, and server label that will be displayed in DCImanager. The value sent to the macros depends on the NoAskingSerialNumber option in the control panel configuration file:

  • " " — request;
  • "yes" — do not request.
  • ($OSINSTALLINFO_HTTPS) - URL to get the information required for OS deployment through https
  • ($OSINSTALLINFO_HTTP) - URL to get the information required for OS deployment through http
  • ($OSINSTALLINFO_HTTPSv4) - URL to get the information required for OS deployment through https IPv4
  • ($OSINSTALLINFO_HTTPv4) - URL to get the information required for OS deployment through http IPv4
  • ($OSINSTALLINFO_HTTPSv6) - URL to get the information required for OS deployment through https IPv6
  • ($OSINSTALLINFO_HTTPv6) - URL to get the information required for OS deployment through http IPv6

($OSINSTALLINFO_SHORT_HTTP) — short URL to get the information required for OS deployment through http IPv6

  • ($PART) — deprecated.
  • ($PASS) - root-user password.
  • ($PASS_CRYPT) - md5 password hash
  • ($RACKFIND_NOLOGIN) — this macro is used in server search templates. The recovery mode will start in the found server. When accessing the server you can remotely specify the rack, unit, serial number, and server label that will be displayed in DCImanager. To facilitate this operation in the "Server search" module you can enable the automatic authentication option:
  • " " — perform;
  • "yes" — do not perform.
  • ($SHAREDIR_FILE) - URL to the directory accessible through http.
  • ($SHAREDIR_FILEv4) - URL to the directory accessible through http IPv4.
  • ($SHAREDIR_FILEv6) - URL to the directory accessible through http IPv6.
  • ($SMB_PATHv4) — path to the Samba-storage through IPv4. It is used for Windows OS.
  • ($SSHPUBKEYS) - list of SSH keys that should be added into /root/.ssh/authorized_keys
  • ($TIMEZONE) — time zone.
  • *($TMPIPv4) - temporary IPv4 address that will be used during OS deployment:
  • true — use;
  • false — do not use.

($WIN_MAC) — MAC-address that is used to define the primary interface of the server during Windows OS setup.