API - Dynamic Variables

Desktop Authority API - Dynamic Variables

Predefined Dynamic Variables can be used to aid in the creation of configuration elements. These variables are globally defined and used by Desktop Authority during the client logon process. Using them is helpful, if not a necessity, when writing custom scripts.

Dynamic Variables can be used in virtually every field within the Desktop Authority manager, including those fields with built-in lists. Simply press the F2 key to display a dialog that allows the selection of a predefined variable from a visual list. The dynamic variable will be inserted at the current position of the cursor.

These variables are available for a few different categories:

Applications Variables
Date and Time Variables
Folder and Disk Variables
Messaging System Variables
Network Variables
Operating System Variables
Security Variables
System Variables

$ConnType

Connection Type:

LAN - LAN or WAN connection

RAS - dial-up networking connection

$Date

Current date (e.g. "2000/04/01")

$Description

Description (from UMD)

$DllDir

Location of OS DLL's (e.g. Windows - "C:\Windows\System") (e.g. Win NT - "D:\WinNT\System32")

$Domain

Domain (or Workgroup) that computer belongs to.

$ExitFlag

If set to 1 in a custom script, Desktop Authority will immediately exit after pre or post-engine custom scripts complete.

$FreeSpace

Available disk space on $SystemDrive (in bytes)

$FreeSpaceMb

Available disk space on $SystemDrive (in Megabytes)

$GreetingTime

"morning", "afternoon" or "evening", based on time of day 00:00-11:59, 12:00-17:59, 18:00-23:59, respectively.

$HomeBase

Base sharename part of $HomePath. (e.g. "Users")

$HomeDir

'Long' name of the directory part of the home directory. (e.g. "bjohnson")

$HomePath

Complete home path, including the server, base share and home directory. (e.g. "\\Server1\Users\JohnSmith")

$HomeServer

Server-only part of $HomePath, without leading backslashes. (e.g. "MyServer")

$HomeShare

Server & base share parts of $HomePath. (e.g. "\\Server\Users")

$HostName

TCP/IP host name of the client.

$IeVersion

Internet Explorer Version

$IPAddr

IP address ( First address detected )

$IPOct1

The first octet of $IPAddr

$IPOct2

The second octet of $IPAddr

$IPOct3

The third octet of $IPAddr

$IPOct4

The fourth octet of $IPAddr

$LogonServer

Authenticating Domain Controller - without leading backslashes. (Example: "server1')

$Lserver

Authenticating Domain Controller - with leading backslashes. (Example: "\\server1")

$MACaddr

Network MAC address (adapter 0)

$MapiDefProfile

Name of the default Windows Messaging System profile for the user logging on.

$NetLogon

location of Desktop Authority scripts on authenticating server in UNC form.

Example 1 - "\\server1\netlogon"

Example 2 - "\\server2\netlogon\site1"

$NtOsVerVal

Numeric value of the OS version, expressed as an integer (e.g. 40 or 50)

$NtType

a PDC, BDC or Member Server will return "Server"

an NT Workstation or Windows 2000 Professional will return "Workstation"

$OsBuildNumber

Operating System build number (e.g. 1381)

$OsCsdVersion

Operating System current service pack (e.g. Service Pack 4.0)

$OsType

Operating System type:

95 - Windows 95

98 - Windows 98

NT - All versions of NT/2000

$OsVersion

Operating System version (e.g. " NT Workstation 4.0")

$Priv

Privilege level of user on the domain: "User" or "Admin"

$ProgramFilesDir

Loc. of Program Files on the client (e.g. " C:\Program Files")

$PwDaysLeft

Number of days before password expiration.

$RestartFlag

If set to 1, user will be forced to logoff. A 2 will force the client to reboot.

$ShellAppData

Location of client's Application Data shell folder.

$ShellCache

Location of client's Temporary Internet Files shell folder.

$ShellCookies

Location of client's Cookies folder.

$ShellDesk

Location of client's Desktop shell folder

$ShellDeskCommon

Location of NT client's Common (All Users) Desktop shell folder.

$ShellFavorites

Location of client's Favorites shell folder (IE bookmarks).

$ShellFonts

Location of client's Fonts shell folder.

$ShellHistory

Location of client's History shell folder.

$ShellLocAppData

Location of client's Local Application Data shell folder.

$ShellMyPictures

Location of client's My Pictures shell folder.

$ShellNetHood

Location of client's Network Neighborhood shell folder.

$ShellPersonal

Location of client's Personal shell folder.

$ShellPrintHood

Location of client's Printer Neighborhood shell folder.

$ShellProg

Location of client's Start-Menu Programs shell folder.

$ShellProgCommon

Location of NT client's Common (All Users) Start-Menu Programs shell folder.

$ShellQLaunch

$ShellRecent

Location of client's Recent Documents shell folder.

$ShellSendTo

Location of client's Send To shell folder.

$ShellSMCommon

Location of NT client's Common (All Users) Start-Menu shell folder.

$ShellStartMenu

Location of client's Start-Menu shell folder

$ShellStartup

Location of client's Startup shell folder.

$ShellTemplates

Location of client's Templates shell folder.

$SiCpuSpeed

System Info: CPU #1 MHz (approx.)

$SiCpuType

System Info: CPU #1 Type

$SiCpuVendID

System Info: CPU #1 Vendor ID

$SID

Security Identifier (SID) of current user.

$SiDesktopSize

System Info: Size of desktop (Width x Height)

$SiHDiskSizeGb

System Info: Size of Hard Drive #1

$SiRamMb

System Info: Physical memory, in Mb

$SiSysBiosDate

System Info: System BIOS Date

$SiSysBiosName

System Info: System BIOS Mfg.

$SiVidBiosDate

System Info: Video BIOS Date

$SystemDrive

Drive where OS loaded from (e.g. "C:")

$TermServClient

0 = Non-Terminal Server Client

1 = Terminal Server Client

$Time

Current time (e.g. "14:10")

$TimeHour

Current 2-digit hour (e.g. "14")

$TimeMin

Current 2-digit minutes (e.g. "10")

$TSClient

0 = Non-Terminal Server Client

1 = Terminal Server Client

$UserID

Logon ID of the user.

$VerboseOs

Operating System version.build (e.g. " NT Workstation 4.0.1381")

$W9xPrfEnabled

For Windows 95 & 98 clients:

0 = User Profiles are not enabled.

1 = User Profiles are enabled.