Stop-CMCloudDistributionPoint
Stop-CMCloudDistributionPoint
Stops the cloud distribution point service.
Syntax
Parameter Set: SearchByIdMandatory
Stop-CMCloudDistributionPoint -Id <String[]> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByNameMandatory
Stop-CMCloudDistributionPoint -Name <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByValueMandatory
Stop-CMCloudDistributionPoint -InputObject <IResultObject> [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Stop-CMCloudDistributionPoint cmdlet stops the cloud distribution point service.
If you use the Stop-CMCloudDistributionPoint cmdlet, System Center 2012 Configuration Manager does not delete content from the distribution point and does not prevent the site server from transferring additional content to the distribution point. While the cloud distribution point service is stopped, the cloud distribution point does not distribute content. Use the Start-CMCloudDistributionPoint cmdlet to restart distribution.
For example, you might want to stop a cloud service when usage reaches a data threshold and then restart it at a later time.
Parameters
-Id<String[]>
Specifies an array of identifiers for cloud distribution points. You can use a comma separated list.
Aliases |
AzureServiceId |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-InputObject<IResultObject>
Specifies a cloud distribution point object. To get a cloud distribution point object, you can use the Get-CMCloudDistributionPoint cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of a cloud distribution point.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
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.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Stop the cloud distribution point service using an ID
This command stops the cloud distribution point service for the cloud distribution point that has the specified identifier.
PS C:\> Stop-CMCloudDistributionPoint -Id "16777242"
Example 2: Stop the cloud distribution point service using a name
This command stops the cloud distribution point service for the cloud distribution point named West01.
PS C:\> Stop-CMCloudDistributionPoint -Name "West01"
Example 3: Stop the cloud distribution point service using an object
The first command uses the Get-CMCloudDistributionPoint cmdlet to get the distribution point with the specified identifier, and then stores it in the $DistPnt variable.
The second command stops the cloud distribution point service for the distribution point stored in $DistPnt.
PS C:\> $DistPnt = Get-CMCloudDistributionPoint -Id "16777242"
PS C:\> Stop-CMCloudDistributionPoint -InputObject $DistPnt