Appendix B: Configuration Macros

Macros can be used in your configuration anywhere an expression is expected. During logon, these macros expand into values based on their definition. For example, when a user with an ID of GPBurdell logs on to a client machine, the “@USERID” macro text is replaced with “GPBurdell”. Macros have many practical uses. The UNC path, \\your-server\@USERID, can be used to map a drive to a per-user share. The @LSERVER macro can be used to set the system time on legacy clients from the authenticating domain controller. This table lists the supported macros and their definitions.

Macro Definition
@CPU Name of the CPU (e.g.: "Intel Pentium III")
@CSD Reflects the most recent service pack version or CSD version information (e.g.: "Service Pack 1")
@CURDIR Current directory
@DATE Date (in the format YYYY/MM/DD)
@DAY Day of the week (Monday, Tuesday, and so on)
@DOMAIN Domain or workgroup the computer belongs to
@FULLNAME Full name of current user
@HOMEDIR Short name of the directory part of home directory
@HOMEDRIVE Drive letter of drive containing home directory
@HOMESHR Server and share name part of home directory
@HOSTNAME Fully qualified TCP/IP host name (including TCP/IP domain name)
@INWIN Operating system: 1 = Windows NT; 2 = Windows 9x
@IPADDRESSx TCP/IP address (possible values for x are 0 - 3)
@KIX KiXtart product name and version
@LANROOT Directory where network software resides (usually Systemroot\System32)
@LDOMAIN Logon domain
@LDRIVE Drive that is redirected to \\logonserver\NETLOGON
@LM Version of network software
@LONGHOMEDIR Long name of the directory part of home directory
@LSERVER Logon server
@MDAYNO Day of the month as a number from 1 to 31
@MHZ Approximation of the CPU speed. Not available on Windows 9x.
@MONTHNO Months since January (1-12)
@MONTH Name of the month (January, February, etc.)
@MSECS Milliseconds part of the current time
@PID Process ID of the KiXtart process
@PRIV User's privilege level (GUEST, USER, ADMIN)
@PRODUCTSUITE Operating system suite. Combination of any of the following values:
1 - "Small Business"
2 - "Enterprise"
4 - "BackOffice"
8 - "CommunicationServer"
16 - "Terminal Server"
32 - "Small Business (Restricted)"
64 - "EmbeddedNT"
128 - "DataCenter"
256 - "Single user Terminal Server"
512 - "Home Edition"
1024 - "Blade Server"
2048 - "Embedded (Restricted)"
4096 - "Security Appliance"
8192 - "Storage Server"
16384- "Computer Cluster Server”
@PRODUCTTYPE

OS type. Possible values:

"Windows 2000 Professional"

"Windows 2000 Server"

"Windows 2000 Domain Controller"

"Windows XP Home Edition"

"Windows XP Professional"

"Windows XP Professional Tablet PC"

"Windows XP Media Center Edition"

"Windows XP Starter Edition"

"Windows Fundamentals for Legacy PCs"

"Windows Server 2003"

"Windows Server 2003 Domain Controller"

"Windows Server 2003 R2"

"Windows Server 2003 R2 Domain Controller"

"Windows Vista Starter Edition"

"Windows Vista Home Basic Edition"

"Windows Vista Home Basic Edition N"

"Windows Vista Home Premium Edition"

"Windows Vista Business Edition"

"Windows Vista Business Edition N"

"Windows Vista Enterprise Edition"

"Windows Vista Ultimate Edition"

"Windows Server 2008 (R2)"

"Windows Server 2008 (R2) Core"

"Windows Server 2008 (R2) Small Business Edition"

"Windows Server 2008 (R2) Enterprise Edition"

"Windows Server 2008 (R2) Enterprise Edition Core"

"Windows Server 2008 (R2) Datacenter Edition"

"Windows Server 2008 (R2) Datacenter Edition Core"

"Windows Server 2008 (R2) Enterprise Edition for Itanium"

"Windows Server 2008 (R2) Web Server Edition"

"Windows Server 2008 (R2) Web Server Edition Core"

"Windows Server 2008 (R2) Compute Cluster Edition"

"Windows Server 2008 (R2) Home Edition"

"Windows Storage Server 2008 (R2) Express Edition"

"Windows Storage Server 2008 (R2) Standard Edition"

"Windows Storage Server 2008 (R2) Enterprise Edition"

"Windows Storage Server 2008 (R2) Small Business Edition"

"Windows Server 2008 (R2) Essential Business Server"

"Windows Server 2008 (R2) Essential Business Server Premium"

"Windows Server 2008 (R2) Essential Business Server Management"

"Windows Server 2008 (R2) Essential Business Messaging"

"Windows Server 2008 (R2) Essential Business Security"

"Windows Server 2008 (R2) Hyper-V"

"Windows Server 2008 (R2) Foundation"

"Windows 7 Starter Edition"

"Windows 7 Starter Edition N"

"Windows 7 Home Basic Edition"

"Windows 7 Home Basic Edition N"

"Windows 7 Home Premium Edition"

"Windows 7 Home Premium Edition N"

"Windows 7 Business Edition"

"Windows 7 Business Edition N"

"Windows 7 Professional Edition"

"Windows 7 Professional Edition N"

"Windows 7 Enterprise Edition"

"Windows 7 Enterprise Edition N"

"Windows 7 Ultimate Edition"

"Windows 7 Ultimate Edition N"

@RAS Number of active Remote Access Service (RAS) connections
@SID Current user's Windows NT Security Identifier (SID)
@SYSLANG Full English name of the language of the operating system specified in the format defined by ISO Standard 639 (for example: ”0413Dutch (Standard)”)
@TICKS Returns the number of milliseconds that have elapsed since the system was started
@TIME Current time (in the format HH:MM:SS)
@USERID Current user's Windows NT user ID
@USERLANG Full English name of the language selected by the current user specified in the format defined by ISO Standard 639 (for example: ”0413Dutch (Standard)”)
@WDAYNO Days since Sunday (1 - 7)
@WKSTA Computer name
@WUSERID Current user's Windows user ID
@YDAYNO Days since January 1 (1 - 365)
@YEAR Current year