Enable-SCOMAgentProxy
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Enable-SCOMAgentProxy
Enables agents to act as a proxy and discover managed objects on other computers.
Syntax
Parameter Set: FromAgent
Enable-SCOMAgentProxy [-Agent] <AgentManagedComputer> [[-PassThru]] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Enable-SCOMAgentProxy cmdlet enables agents to act as a proxy and discover 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 enables the agent to act as a proxy for other agents.
PS C:\>"Server01.Contoso.com" | Get-SCOMAgent | Enable-SCOMAgentProxy -PassThru
-------------------------- EXAMPLE 2 --------------------------
Description
-----------
This command gets all agents that have their ProxyingEnabled value set to false and then enables the agents to act as a proxy after confirming the action.
PS C:\>Get-SCOMAgent | where {$_.ProxyingEnabled.Value -eq $False} | Enable-SCOMAgentProxy -Confirm
-------------------------- EXAMPLE 3 --------------------------
Description
-----------
The Proxying Enabled value is stored in the ProxyingEnabled property of the object that represents an SCAgent. The first command gets the agent named "Server01.Contoso.com", and the second command displays the value for the ProxyingEnabled property of that agent.
PS C:\>$Agent = Get-SCOMAgent -Name "Server01.Contoso.com"
PS C:\>$Agent.ProxyingEnabled