< Back
Set-AMAgentProperty
Post
NAME Set-AMAgentProperty
SYNOPSIS
Sets the properties of an AutoMate Enterprise agent.
SYNTAX
Set-AMAgentProperty [-InputObject] <Object> [-DefaultUserPropertiesSpecified] [[-DefaultRunAsUserName] <String>]
[[-DefaultRunAsPassword] <String>] [[-DefaultRunAsDomain] <String>] [[-LogonScript] <String>] [[-UnlockScript]
<String>] [[-LogonScriptKeystrokeDelay] <Int32>] [-IndicatorsPropertiesSpecified] [[-ShowTrayIcon] {Always | Never
| RunOnly}] [-ShowTrayIconMenu] [-ShowRunningTaskWindow] [-RunningTaskWindowWithTitleBar] [-RunningTaskOnTop]
[-RunningTaskWindowTransparent] [-UseInterruptHotkey] [[-InterruptHotkey] <String>] [-StagingPropertiesSpecified]
[-UseLowestCompletionState] [[-LowestCompletionState] {InDevelopment | Testing | Production | Archive}]
[-LoadManagementPropertiesSpecified] [[-MaxRunningTasks] <Int32>] [-ProxyPropertiesSpecified] [[-SocksType]
{NoProxy | Socks4 | Socks4a | Socks5 | HTTP}] [[-ProxyHost] <String>] [[-ProxyPort] <Int32>] [[-ProxyUserID]
<String>] [[-ProxyPassword] <String>] [-SNMPPropertiesSpecified] [[-MIBLocation] <String>] [[-SNMPTrapPort]
<Int32>] [-EmailPropertiesSpecified] [[-EmailProtocol] {SMTP | Webdav | EWS}] [[-EmailServer] <String>]
[[-EmailPort] <Int32>] [[-EmailAuthenticationType] <String>] [[-EmailUserName] <String>] [[-EmailPassword]
<String>] [[-EmailSecurity] {None | Explicit | Implicit}] [[-EmailCertificate] <String>]
[[-EmailCertificatePassphrase] <String>] [-EmailIgnoreServerCertificate] [[-EmailAddress] <String>]
[-EmailUseAutoDiscovery] [[-EmailExchangeProtocol] {HTTPS | HTTP}] [[-EmailUrl] <String>] [[-EmailDomainName]
<String>] [[-EmailVersion] {Exchange2007SP1 | Exchange2010 | Exchange2010SP1 | Exchange2010SP2 | Exchange2013}]
[[-EmailProxyType] {NoProxy | Socks4 | Socks4a | Socks5 | HTTP}] [[-EmailProxyServer] <String>] [[-EmailProxyPort]
<Int32>] [[-EmailProxyUsername] <String>] [[-EmailProxyPassword] <String>] [-SystemPropertiesSpecified]
[[-AgentPort] <Int32>] [[-TaskCacheFilePath] <String>] [[-EventMonitorAutoMateStartMode] {FirstComeFirstServed |
ConsoleOnly | TerminalServiceUser | Off}] [-DisableForegroundTimeout] [[-EventMonitorUser] <String>] [-WhatIf]
[-Confirm] [<CommonParameters>]
DESCRIPTION
Set-AMAgentProperty modifies agent properties.
PARAMETERS
-InputObject <Object>
The agent property to modify.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-DefaultUserPropertiesSpecified [<SwitchParameter>]
Whether the default user settings are specified (true) or inherited (false) from the server.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-DefaultRunAsUserName <String>
The default user name that agents should use when automatically logging onto or unlocking a workstation.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DefaultRunAsPassword <String>
The default password to be used with the user name specified.
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DefaultRunAsDomain <String>
The domain or machine name associated with the user. This parameter can be left blank if the user is not a
member of a domain or if there is only one workgroup for the machine.
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LogonScript <String>
The keystrokes to use in order for an agent to successfully log onto the workstation when a user is not
present. Automate will simulate a user entering these keystrokes onto the Windows Logon screen.
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UnlockScript <String>
The keystrokes to use in order for the agent to successfully unlock the workstation. Automate will simulate a
user entering these keystrokes in order to successfully unlock a machine.
Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LogonScriptKeystrokeDelay <Int32>
The number of milliseconds to pause between each keystroke. By default, Automate will press each key of the
key sequence every 200 milliseconds. Adjust this number if keystrokes appear to be missing during the logon or
unlock process, which may indicate that they are being typed too quickly.
Required? false
Position? 7
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-IndicatorsPropertiesSpecified [<SwitchParameter>]
Whether the indicator settings are specified (true) or inherited (false) from the server.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-ShowTrayIcon
Indicates whether the Automate "A" icon should be displayed in the system tray of the agent machine.
Required? false
Position? 8
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ShowTrayIconMenu [<SwitchParameter>]
If enabled, allows right-clicks to be performed on the tray icon in order to display a context menu.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-ShowRunningTaskWindow [<SwitchParameter>]
If enabled, the agent computer displays a small indicator window in the lower right-hand corner of the desktop
during task execution.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-RunningTaskWindowWithTitleBar [<SwitchParameter>]
If enabled, a title bar is displayed on the Running Task Indicator window.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-RunningTaskOnTop [<SwitchParameter>]
If enabled, puts the Running Task Indicator window on top of all other open windows on the desktop.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-RunningTaskWindowTransparent [<SwitchParameter>]
If enabled, the Running Task Indicator window appears transparent.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-UseInterruptHotkey [<SwitchParameter>]
If enabled, activates the Task interruption hotkey parameter which allows entry of a specific hotkey
combination used to interrupt running tasks.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-InterruptHotkey <String>
Specifies the hot-key combination to enter in order to suspend one or more running tasks and invoke the a
Running Tasks dialog.
Required? false
Position? 9
Default value
Accept pipeline input? false
Accept wildcard characters? false
-StagingPropertiesSpecified [<SwitchParameter>]
Whether the staging settings are specified (true) or inherited (false) from the server.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-UseLowestCompletionState [<SwitchParameter>]
If enabled, tasks and conditions will execute on the agent only if the completion state is equal to or higher
than the one specified.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-LowestCompletionState
InDevelopment (default) - Tells the system to run all tasks and conditions currently in development stage
(lowest stage) or higher, which basically indicates all tasks and conditions.
Testing - Tells the system to run all tasks and conditions that are currently in the testing stage or
higher.
Production - Tells the system to run all tasks and conditions currently in the production stage or
higher.
Archive - Tells the system to run all tasks and conditions currently in the archive stage.
Required? false
Position? 10
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LoadManagementPropertiesSpecified [<SwitchParameter>]
Whether the load management settings are specified (true) or inherited (false) from the server.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-MaxRunningTasks <Int32>
Specifies the maximum number of tasks that should run simultaneously on a given agent.
Required? false
Position? 11
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-ProxyPropertiesSpecified [<SwitchParameter>]
Whether the proxy settings are specified (true) or inherited (false) from the server.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-SocksType
The proxy protocol that the proxy server uses to accept requests from Automate Enterprise.
Required? false
Position? 12
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ProxyHost <String>
The host name or host address of the proxy to use.
Required? false
Position? 13
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ProxyPort <Int32>
The port on the proxy server to use.
Required? false
Position? 14
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-ProxyUserID <String>
The user name to authenticate proxy requests.
Required? false
Position? 15
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ProxyPassword <String>
The password to authenticate proxy requests.
Required? false
Position? 16
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SNMPPropertiesSpecified [<SwitchParameter>]
Whether the SNMP settings are specified (true) or inherited (false) from the server.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-MIBLocation <String>
Indicates the directory location of the MIB (Management Information Base) files.
Required? false
Position? 17
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SNMPTrapPort <Int32>
The port that Automate Enterprise will use to listen for traps using the SNMP Trap Condition.
Required? false
Position? 18
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-EmailPropertiesSpecified [<SwitchParameter>]
Whether the email settings are specified (true) or inherited (false) from the server.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-EmailProtocol
The email protocol to communicate with.
Required? false
Position? 19
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailServer <String>
The name of the mail server that will send emails generated by Automate Enterprise.
Required? false
Position? 20
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailPort <Int32>
The default port that the mail server uses.
Required? false
Position? 21
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-EmailAuthenticationType <String>
Specifies the authentication type to administer.
Required? false
Position? 22
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailUserName <String>
Specifies the username that the server authenticates with.
Required? false
Position? 23
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailPassword <String>
Specifies the password matching the username that the server authenticates with.
Required? false
Position? 24
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailSecurity
The type of security that this action should use.
Required? false
Position? 25
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailCertificate <String>
The full path and file name of the certificate (.cer or .pfx extension) used to authenticate with.
Required? false
Position? 26
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailCertificatePassphrase <String>
The passphrase used to authenticate the SSL/TLS private key file.
Required? false
Position? 27
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailIgnoreServerCertificate [<SwitchParameter>]
Invalid or expired SSL server certificates that are detected will be ignored.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-EmailAddress <String>
The Exchange server email address to use for email transactions.
Required? false
Position? 28
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailUseAutoDiscovery [<SwitchParameter>]
Automatically discover the server based on the email address entered in the EmailAddress parameter.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-EmailExchangeProtocol
The protocol to use for email transactions.
Required? false
Position? 29
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailUrl <String>
The URL for the email server.
Required? false
Position? 30
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailDomainName <String>
The domain name to authenticate with.
Required? false
Position? 31
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailVersion
The email server version.
Required? false
Position? 32
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailProxyType
The proxy protocol used.
Required? false
Position? 33
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailProxyServer <String>
The hostname or IP address of the proxy server.
Required? false
Position? 34
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailProxyPort <Int32>
The port used to communicate with the proxy server.
Required? false
Position? 35
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-EmailProxyUsername <String>
The username used to authenticate connection to the proxy server.
Required? false
Position? 36
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailProxyPassword <String>
The password used to authenticate the username specified.
Required? false
Position? 37
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SystemPropertiesSpecified [<SwitchParameter>]
Whether the system settings are specified (true) or inherited (false) from the server.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-AgentPort <Int32>
Specifies the default port that connected agents should use to communicate with the server component.
Required? false
Position? 38
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-TaskCacheFilePath <String>
The path to cache task files on the agent.
Required? false
Position? 39
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EventMonitorAutoMateStartMode
The event monitor user context.
Required? false
Position? 40
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DisableForegroundTimeout [<SwitchParameter>]
If this option is enabled, Windows Foreground Timeout functionality is turned off, allowing Automate to
properly bring specific windows into the foreground.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-EventMonitorUser <String>
The user to run the event monitor as.
Required? false
Position? 41
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
RELATED LINKS
https://github.com/AutomatePS/AutomatePS
SYNOPSIS
Sets the properties of an AutoMate Enterprise agent.
SYNTAX
Set-AMAgentProperty [-InputObject] <Object> [-DefaultUserPropertiesSpecified] [[-DefaultRunAsUserName] <String>]
[[-DefaultRunAsPassword] <String>] [[-DefaultRunAsDomain] <String>] [[-LogonScript] <String>] [[-UnlockScript]
<String>] [[-LogonScriptKeystrokeDelay] <Int32>] [-IndicatorsPropertiesSpecified] [[-ShowTrayIcon] {Always | Never
| RunOnly}] [-ShowTrayIconMenu] [-ShowRunningTaskWindow] [-RunningTaskWindowWithTitleBar] [-RunningTaskOnTop]
[-RunningTaskWindowTransparent] [-UseInterruptHotkey] [[-InterruptHotkey] <String>] [-StagingPropertiesSpecified]
[-UseLowestCompletionState] [[-LowestCompletionState] {InDevelopment | Testing | Production | Archive}]
[-LoadManagementPropertiesSpecified] [[-MaxRunningTasks] <Int32>] [-ProxyPropertiesSpecified] [[-SocksType]
{NoProxy | Socks4 | Socks4a | Socks5 | HTTP}] [[-ProxyHost] <String>] [[-ProxyPort] <Int32>] [[-ProxyUserID]
<String>] [[-ProxyPassword] <String>] [-SNMPPropertiesSpecified] [[-MIBLocation] <String>] [[-SNMPTrapPort]
<Int32>] [-EmailPropertiesSpecified] [[-EmailProtocol] {SMTP | Webdav | EWS}] [[-EmailServer] <String>]
[[-EmailPort] <Int32>] [[-EmailAuthenticationType] <String>] [[-EmailUserName] <String>] [[-EmailPassword]
<String>] [[-EmailSecurity] {None | Explicit | Implicit}] [[-EmailCertificate] <String>]
[[-EmailCertificatePassphrase] <String>] [-EmailIgnoreServerCertificate] [[-EmailAddress] <String>]
[-EmailUseAutoDiscovery] [[-EmailExchangeProtocol] {HTTPS | HTTP}] [[-EmailUrl] <String>] [[-EmailDomainName]
<String>] [[-EmailVersion] {Exchange2007SP1 | Exchange2010 | Exchange2010SP1 | Exchange2010SP2 | Exchange2013}]
[[-EmailProxyType] {NoProxy | Socks4 | Socks4a | Socks5 | HTTP}] [[-EmailProxyServer] <String>] [[-EmailProxyPort]
<Int32>] [[-EmailProxyUsername] <String>] [[-EmailProxyPassword] <String>] [-SystemPropertiesSpecified]
[[-AgentPort] <Int32>] [[-TaskCacheFilePath] <String>] [[-EventMonitorAutoMateStartMode] {FirstComeFirstServed |
ConsoleOnly | TerminalServiceUser | Off}] [-DisableForegroundTimeout] [[-EventMonitorUser] <String>] [-WhatIf]
[-Confirm] [<CommonParameters>]
DESCRIPTION
Set-AMAgentProperty modifies agent properties.
PARAMETERS
-InputObject <Object>
The agent property to modify.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-DefaultUserPropertiesSpecified [<SwitchParameter>]
Whether the default user settings are specified (true) or inherited (false) from the server.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-DefaultRunAsUserName <String>
The default user name that agents should use when automatically logging onto or unlocking a workstation.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DefaultRunAsPassword <String>
The default password to be used with the user name specified.
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DefaultRunAsDomain <String>
The domain or machine name associated with the user. This parameter can be left blank if the user is not a
member of a domain or if there is only one workgroup for the machine.
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LogonScript <String>
The keystrokes to use in order for an agent to successfully log onto the workstation when a user is not
present. Automate will simulate a user entering these keystrokes onto the Windows Logon screen.
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UnlockScript <String>
The keystrokes to use in order for the agent to successfully unlock the workstation. Automate will simulate a
user entering these keystrokes in order to successfully unlock a machine.
Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LogonScriptKeystrokeDelay <Int32>
The number of milliseconds to pause between each keystroke. By default, Automate will press each key of the
key sequence every 200 milliseconds. Adjust this number if keystrokes appear to be missing during the logon or
unlock process, which may indicate that they are being typed too quickly.
Required? false
Position? 7
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-IndicatorsPropertiesSpecified [<SwitchParameter>]
Whether the indicator settings are specified (true) or inherited (false) from the server.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-ShowTrayIcon
Indicates whether the Automate "A" icon should be displayed in the system tray of the agent machine.
Required? false
Position? 8
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ShowTrayIconMenu [<SwitchParameter>]
If enabled, allows right-clicks to be performed on the tray icon in order to display a context menu.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-ShowRunningTaskWindow [<SwitchParameter>]
If enabled, the agent computer displays a small indicator window in the lower right-hand corner of the desktop
during task execution.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-RunningTaskWindowWithTitleBar [<SwitchParameter>]
If enabled, a title bar is displayed on the Running Task Indicator window.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-RunningTaskOnTop [<SwitchParameter>]
If enabled, puts the Running Task Indicator window on top of all other open windows on the desktop.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-RunningTaskWindowTransparent [<SwitchParameter>]
If enabled, the Running Task Indicator window appears transparent.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-UseInterruptHotkey [<SwitchParameter>]
If enabled, activates the Task interruption hotkey parameter which allows entry of a specific hotkey
combination used to interrupt running tasks.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-InterruptHotkey <String>
Specifies the hot-key combination to enter in order to suspend one or more running tasks and invoke the a
Running Tasks dialog.
Required? false
Position? 9
Default value
Accept pipeline input? false
Accept wildcard characters? false
-StagingPropertiesSpecified [<SwitchParameter>]
Whether the staging settings are specified (true) or inherited (false) from the server.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-UseLowestCompletionState [<SwitchParameter>]
If enabled, tasks and conditions will execute on the agent only if the completion state is equal to or higher
than the one specified.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-LowestCompletionState
InDevelopment (default) - Tells the system to run all tasks and conditions currently in development stage
(lowest stage) or higher, which basically indicates all tasks and conditions.
Testing - Tells the system to run all tasks and conditions that are currently in the testing stage or
higher.
Production - Tells the system to run all tasks and conditions currently in the production stage or
higher.
Archive - Tells the system to run all tasks and conditions currently in the archive stage.
Required? false
Position? 10
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LoadManagementPropertiesSpecified [<SwitchParameter>]
Whether the load management settings are specified (true) or inherited (false) from the server.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-MaxRunningTasks <Int32>
Specifies the maximum number of tasks that should run simultaneously on a given agent.
Required? false
Position? 11
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-ProxyPropertiesSpecified [<SwitchParameter>]
Whether the proxy settings are specified (true) or inherited (false) from the server.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-SocksType
The proxy protocol that the proxy server uses to accept requests from Automate Enterprise.
Required? false
Position? 12
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ProxyHost <String>
The host name or host address of the proxy to use.
Required? false
Position? 13
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ProxyPort <Int32>
The port on the proxy server to use.
Required? false
Position? 14
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-ProxyUserID <String>
The user name to authenticate proxy requests.
Required? false
Position? 15
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ProxyPassword <String>
The password to authenticate proxy requests.
Required? false
Position? 16
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SNMPPropertiesSpecified [<SwitchParameter>]
Whether the SNMP settings are specified (true) or inherited (false) from the server.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-MIBLocation <String>
Indicates the directory location of the MIB (Management Information Base) files.
Required? false
Position? 17
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SNMPTrapPort <Int32>
The port that Automate Enterprise will use to listen for traps using the SNMP Trap Condition.
Required? false
Position? 18
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-EmailPropertiesSpecified [<SwitchParameter>]
Whether the email settings are specified (true) or inherited (false) from the server.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-EmailProtocol
The email protocol to communicate with.
Required? false
Position? 19
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailServer <String>
The name of the mail server that will send emails generated by Automate Enterprise.
Required? false
Position? 20
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailPort <Int32>
The default port that the mail server uses.
Required? false
Position? 21
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-EmailAuthenticationType <String>
Specifies the authentication type to administer.
Required? false
Position? 22
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailUserName <String>
Specifies the username that the server authenticates with.
Required? false
Position? 23
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailPassword <String>
Specifies the password matching the username that the server authenticates with.
Required? false
Position? 24
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailSecurity
The type of security that this action should use.
Required? false
Position? 25
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailCertificate <String>
The full path and file name of the certificate (.cer or .pfx extension) used to authenticate with.
Required? false
Position? 26
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailCertificatePassphrase <String>
The passphrase used to authenticate the SSL/TLS private key file.
Required? false
Position? 27
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailIgnoreServerCertificate [<SwitchParameter>]
Invalid or expired SSL server certificates that are detected will be ignored.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-EmailAddress <String>
The Exchange server email address to use for email transactions.
Required? false
Position? 28
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailUseAutoDiscovery [<SwitchParameter>]
Automatically discover the server based on the email address entered in the EmailAddress parameter.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-EmailExchangeProtocol
The protocol to use for email transactions.
Required? false
Position? 29
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailUrl <String>
The URL for the email server.
Required? false
Position? 30
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailDomainName <String>
The domain name to authenticate with.
Required? false
Position? 31
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailVersion
The email server version.
Required? false
Position? 32
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailProxyType
The proxy protocol used.
Required? false
Position? 33
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailProxyServer <String>
The hostname or IP address of the proxy server.
Required? false
Position? 34
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailProxyPort <Int32>
The port used to communicate with the proxy server.
Required? false
Position? 35
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-EmailProxyUsername <String>
The username used to authenticate connection to the proxy server.
Required? false
Position? 36
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailProxyPassword <String>
The password used to authenticate the username specified.
Required? false
Position? 37
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SystemPropertiesSpecified [<SwitchParameter>]
Whether the system settings are specified (true) or inherited (false) from the server.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-AgentPort <Int32>
Specifies the default port that connected agents should use to communicate with the server component.
Required? false
Position? 38
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-TaskCacheFilePath <String>
The path to cache task files on the agent.
Required? false
Position? 39
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EventMonitorAutoMateStartMode
The event monitor user context.
Required? false
Position? 40
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DisableForegroundTimeout [<SwitchParameter>]
If this option is enabled, Windows Foreground Timeout functionality is turned off, allowing Automate to
properly bring specific windows into the foreground.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-EventMonitorUser <String>
The user to run the event monitor as.
Required? false
Position? 41
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
RELATED LINKS
https://github.com/AutomatePS/AutomatePS