CMS\_RunUserAgent
Description
Section titled “Description”Creates a ‘CallHomeUser’ Unitcommand is in the SQL database, that will force the InfoCenter of the current user on the computer to launch the agent script.
Syntax
Section titled “Syntax”:vb: Not implemented. See CMS_RerunAgent
:ps: [bool]CMS_RunUserAgent -delay <string>
Parameters
Section titled “Parameters”delay (string)
The delay after which the CallHomeUser unitCommand will be executed.
The format used for delay is very simple. Here are some examples:
‘2m’ is two minutes.
‘1h’ is one hour
‘4h35m11s’ is four hours, thirty-five minutes and eleven seconds
‘2m30s’ is two minutes and thirty seconds
‘0s’ or ” (an empty string) equals no delay and means that the command will be executed right after the current agent run.
Return value
Section titled “Return value”:ps: Boolean, TRUE if function completed successfully.
Example
Section titled “Example”:ps: PowerShell
Section titled “:ps: PowerShell”# run the user agent in 2 minutesCMS_RunUserAgent -delay '2m'
# run the user agent in half an hourCMS_RunUserAgent '30m'
# run the useragent without a delayCMS_RunUserAgent -delay '0s'Related functions
Section titled “Related functions”