Disable-DPMProductionServer
Disable-DPMProductionServer
Disables a DPM protection agent.
Syntax
Parameter Set: Default
Disable-DPMProductionServer [-ProductionServer] <ProductionServer> [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Disable-DPMProductionServer cmdlet disables the System Center 2012 – Data Protection Manager (DPM) protection agent on a computer. After you disable a DPM protection agent, backup jobs for the computer do not run.
Parameters
-ProductionServer<ProductionServer>
Specifies a computer on which a DPM protection agent is installed. This cmdlet disables the protection agent.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
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 (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- ProductionServer
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Disable a protection agent
The first command gets the DPM protection agent on the computer named dist01.contoso.com for the DPM server named DpmWest01. The command stores the result in the $DpmServer variable.
The second command disables the protection agent stored in $DpmServer.
PS C:\> $DpmServer = Get-DPMProductionServer -DPMServerName "DpmWest01" | Where {$_.Name -eq "dist01.contoso.com"}
PS C:\> Disable-DPMProductionServer -ProductionServer $DpmServer