Skip to main content

Built-in Functions

Apart from the standard PSLang built-in functions, there are several built-in agent functions available to the agents.

You call the following built-ins from within functions representing agent operations in order to communicate the results of the operation back to the agent:

  • agentError reports an error message.

  • agentWarning reports a warning message.

  • agentInfo reports an information message.

  • agentListUser is called once for each user during the list operation.

  • agentListGroup (or agentListGroupSID) is called once for each group during the list operation.

  • agentListAttribute is called once for each attribute during the list attribute, create, and update operations.

  • agentListResourceComputer is called once for each computer object during the list resource operation.

  • agentListResourceAccount is called once for each account object during the list resource operation.

  • agentIsEnabled tells the agent whether or not the given user is enabled.

  • agentIsLocked tells the agent whether or not the given user is locked out.

  • agentIsPassExpired tells the agent whether or not the given user’s password has expired.

  • agentIsAcctExpired tells the agent whether or not the given user’s account has expired.

  • agentLongId provides the long ID of the user during create, update, rename, or move context operations.

  • agentShortID provides the short ID of the user during create, update, rename, or move context operations.

  • agentGroups provides the list of groups to which a user belongs.

  • agentOutput can return IP information on reset using agentOutput. The keys are ip-address and dns-host-name. This information is used by Bravura Privilege to load current information when the reset occurs. This is included in the agtssh-simple.psl sample. By default it is disabled. It can be enabled with the $emit_info at the top of the script by setting it to non-zero.

See the PSLang Reference Manual (pslang.pdf) for more information about these built-in functions.