Disable-SCOMAgentProxy
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Disable-SCOMAgentProxy
Disables agents from acting as a proxy and discovering managed objects on other computers.
Syntax
Parameter Set: FromAgent
Disable-SCOMAgentProxy [-Agent] <AgentManagedComputer> [[-PassThru]] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Disable-SCOMAgentProxy cmdlet disables agents from acting as a proxy and discovering managed objects on other computers. This cmdlet requires an agent object.
Parameters
-Agent<AgentManagedComputer>
Specifies one or more agent objects. Enter a variable that represents the agents, or type a command that gets the agents. For information about how to get an agent object, type Get-Help Get-SCOMAgent.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-PassThru
Returns an object representing the updated settings. By default, this cmdlet does not generate any output.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before executing the command.
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Describes what would happen if you executed the command without actually executing the command.
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters
Examples
-------------------------- EXAMPLE 1 --------------------------
Description
-----------
This command gets the agent named "Server01.Contoso.com" and disables it from acting as a proxy.
PS C:\>"Server01.Contoso.com" | Get-SCOMAgent | Disable-SCOMAgentProxy
-------------------------- EXAMPLE 2 --------------------------
Description
-----------
This command gets all agents that have their ProxyingEnabled property set to True and then disables the agents from acting as a proxy.
PS C:\>Get-SCOMAgent | where {$_.ProxyingEnabled.Value -eq $True} | Disable-SCOMAgentProxy