Built-in variables

$KeyAccounts

Value: "accounts" Description: List of accounts.

$KeyAcctID

Value: "acctid" Description: Name of the target account to operate on.

$KeyAction

Value: "ACTION" Description: Action to do to the attribute.

$KeyActionCopy

Value: "COPY" Description: Action to do to the attribute.

$KeyActionIgnore

Value: "IGNORE" Description: Action to do to the attribute.

$KeyActionReplace

Value: "REPLACE" Description: Action to do to the attribute.

$KeyActionValue

Value: "VALUE" Description: Value of the attribute.

$KeyAddress

Value: "address" Description: The address line to use to connect to the target.

$KeyAddrComps

Value: "addresscomponents" Description: Key to the sub-array containing the address elements already split.

$KeyAdminID

Value: "adminid" Description: Name of the account to connect to target as.

$KeyAdminPW

Value: "adminpw" Description: Password of the account to connect to the target with.

$KeyAttribute

Value: "attribute" Description: Single account attribute details.

$KeyAttributes

Value: "attributes" Description: List of account details.

$KeyAuthKey

Value: "authkey" Description: SSH Authentication key attribute.

$KeyBoolean

Value: "boolean" Description: true/false address attribute type

$KeyCAPath

Value: "CApath" Description: Path to certificate file.

$KeyCAFile

Value: "CAfile" Description: Certificate file name.

$KeyChildGroupID

Value: "childgroupid"

$KeyCheckCert

Value: "checkCert" Description: Should the agent check the SSL certificate.

$KeyCommand

Value: "command" Description: Command to run during runcommand() operation.

$KeyCommandFile

Value: "commandfilename" Description: File where the output from runcommand() operation is written to.

$KeyCompression

Value: "compression" Description: SSH address attribute to compress the data transmitted.

$KeyFalse

Value: "false" Description: String used for boolean address and account attributes.

$KeyFullName

Value: "fullname" Description: Description attribute of an account.

$KeyGroup

Value: "group" Description: Single sub KV of a group on the target.

$KeyGroupID

Value: "groupid" Description: Identifier for the group.

$KeyGroupName

Value: "groupname" Description: Name of the group.

$KeyGroups

Value: "groups" Description: List of groups.

$KeyHostID

Value: "hostid" Description:

$KeyHostKeysDenyUnmatched

Value: "DenyUnmatch" Description: Tells the SSH library to connect ONLY if the host key matches an existing one.

$KeyHostKeysUpdate

Value: "AllowUpdate" Description: Allows the SSH connection to update the host key if one already exists (unsafe).

$KeyHostKeysAppend

Value: "AllowAppend" Description: Tells the SSH libary to add the host key if it is missing, but refuse if it does not match.

$KeyInteger

Value: "integer" Description: Integral address attribute type.

$KeyKvgroup

Value: "kvgroup" Description: Address attribute type.

$KeyManagedGroup

Value: "managedGroup"

$KeyModelUID

Value: "modeluid" Description: Account to use as a template when creating a new user.

$KeyNewPW

Value: "newpw" Description: Password for the new account or the new password when resetting an existing account.

$KeyNoPTY

Value: "nopty"

$KeyOldPW

Value: "oldpw" Description: Current password for an account.

$KeyOperation

Value: "operation" Description: The action that is currently underway.

$KeyPort

Value: "port" Description: IP port to connect to on the target.

$KeyPosition

Value: "position" Description:

$KeyReadOnly

Value: "readonly" Description: Address attribute that is not modifiable by the user.

$KeyResource

Value: "resource" Description:

$KeyResourceAddress

Value: "resourceaddress" Description:

$KeyResourceType

Value: "resourcetype" Description:

$KeyRestricted

Value: "restricted" Description: Address attribute type of restricted values.

$KeyRestrictedValue

Value: "restrictedvalue" Description: Key for the chosen restricted address attribute value.

$KeyRestrictedValueText

Value: "restrictedvaluetext" Description: Display value for a restricted address attribute value.

$KeyRestart

Value: "restart" Description:

$KeyRevision

Value: "rev" Description:

$KeyScript

Value: "script" Description: Address attribute type.

$KeyFile

Value: "file" Description: Address attribute type.

$KeyDir

Value: "dir" Description: Address attribute type.

$KeyPath

Value: "path" Description: Address attribute type.

$KeyServer

Value: "server" Description: Address attribute containing the target to connect to.

$KeyServerInfo

Value: "serverinfo" Description: Operation to query the target for version and status information.

$KeySettings

Value: "settings" Description:

$KeyShortID

Value: "shortid" Description: User’s ID

$KeySSL

Value: "SSL" Description: Address attribute determining if encrypted telnet should be used.

$KeyString

Value: "string" Description:

$KeySysID

Value: "sysID" Description: Username for secondary login to the target (e.g. sudo).

$KeySysPassword

Value: "syspassword" Description: Password for the secondary login to the target.

$KeyTerm

Value: "terminal" Description: Address attribute determining the terminal type for the telnet connection.

$KeyTimeout

Value: "timeout" Description: Address attribute defining how long the agent should wait for connection to complete.

$KeyTrue

Value: "true" Description: String used for boolean address and account attributes.

$KeyWriteOption

Value: "writeoption" Description: Address attribute determining the terminal type for the telnet connection.