Skip to content

Latest commit

 

History

History
187 lines (135 loc) · 4.26 KB

Sync-CMCloudManagementGateway.md

File metadata and controls

187 lines (135 loc) · 4.26 KB
external help file Module Name ms.date online version schema
AdminUI.PS.dll-Help.xml
ConfigurationManager
03/26/2021
2.0.0

Sync-CMCloudManagementGateway

SYNOPSIS

Synchronize the configuration of a cloud management gateway to Azure.

SYNTAX

SearchByValueMandatory (Default)

Sync-CMCloudManagementGateway -InputObject <IResultObject> [-DisableWildcardHandling] [-ForceWildcardHandling]
 [-WhatIf] [-Confirm] [<CommonParameters>]

SearchByIdMandatory

Sync-CMCloudManagementGateway -Id <String> [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf]
 [-Confirm] [<CommonParameters>]

SearchByNameMandatory

Sync-CMCloudManagementGateway -Name <String> [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION

Use this cmdlet to synchronize the configuration of a cloud management gateway (CMG) to Azure.

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

EXAMPLES

Example 1: Sync a CMG by name

Sync-CMCloudManagementGateway -Name "GraniteFalls.cloudapp.net"

Example 2: Sync a CMG by pipeline object

If you already have a variable that stores a CMG object from Get-CMCloudManagementGateway, then you can pass it via the pipeline operator to this cmdlet.

$cmg = Get-CMCloudManagementGateway -Name "GraniteFalls.cloudapp.net"

$cmg | Sync-CMCloudManagementGateway

PARAMETERS

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Id

Specify the ID of a CMG to synchronize. This value is the AzureServiceID property of the SMS_AzureService WMI class. The Get-CMCloudManagementGateway cmdlet returns this object.

Type: String
Parameter Sets: SearchByIdMandatory
Aliases: AzureServiceId

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-InputObject

Specify a CMG object to synchronize. To get this object, use the Get-CMCloudManagementGateway cmdlet.

Type: IResultObject
Parameter Sets: SearchByValueMandatory
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

Specify the service name of the CMG to synchronize.

Type: String
Parameter Sets: SearchByNameMandatory
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

OUTPUTS

System.Object

NOTES

RELATED LINKS

Get-CMCloudManagementGateway