Edit

Share via

Set-CMCloudManagementGateway

Module:
ConfigurationManager Module

Configure a cloud management gateway (CMG).

Syntax

SetByValue (Default) 

Set-CMCloudManagementGateway
    -InputObject <IResultObject>
    [-CARootCert <Hashtable>]
    [-CheckClientCertRevocation <Boolean>]
    [-Description <String>]
    [-EnableCloudDPFunction <Boolean>]
    [-EnableStorageQuota <Boolean>]
    [-EnableTrafficOut <Boolean>]
    [-EnforceProtocol <Boolean>]
    [-Force]
    [-PassThru]
    [-RemoveCertThumbprints <String[]>]
    [-ServiceCertPassword <SecureString>]
    [-ServiceCertPath <String>]
    [-StorageCriticalPct <Int32>]
    [-StorageQuotaGB <Int32>]
    [-StorageWarningPct <Int32>]
    [-TrafficCriticalPct <Int32>]
    [-TrafficOutGB <Int32>]
    [-TrafficOutStopService <Boolean>]
    [-TrafficWarningPct <Int32>]
    [-VMInstanceCount <Int32>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetById 

Set-CMCloudManagementGateway
    -Id <String>
    [-CARootCert <Hashtable>]
    [-CheckClientCertRevocation <Boolean>]
    [-Description <String>]
    [-EnableCloudDPFunction <Boolean>]
    [-EnableStorageQuota <Boolean>]
    [-EnableTrafficOut <Boolean>]
    [-EnforceProtocol <Boolean>]
    [-Force]
    [-PassThru]
    [-RemoveCertThumbprints <String[]>]
    [-ServiceCertPassword <SecureString>]
    [-ServiceCertPath <String>]
    [-StorageCriticalPct <Int32>]
    [-StorageQuotaGB <Int32>]
    [-StorageWarningPct <Int32>]
    [-TrafficCriticalPct <Int32>]
    [-TrafficOutGB <Int32>]
    [-TrafficOutStopService <Boolean>]
    [-TrafficWarningPct <Int32>]
    [-VMInstanceCount <Int32>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetByName 

Set-CMCloudManagementGateway
    -Name <String>
    [-CARootCert <Hashtable>]
    [-CheckClientCertRevocation <Boolean>]
    [-Description <String>]
    [-EnableCloudDPFunction <Boolean>]
    [-EnableStorageQuota <Boolean>]
    [-EnableTrafficOut <Boolean>]
    [-EnforceProtocol <Boolean>]
    [-Force]
    [-PassThru]
    [-RemoveCertThumbprints <String[]>]
    [-ServiceCertPassword <SecureString>]
    [-ServiceCertPath <String>]
    [-StorageCriticalPct <Int32>]
    [-StorageQuotaGB <Int32>]
    [-StorageWarningPct <Int32>]
    [-TrafficCriticalPct <Int32>]
    [-TrafficOutGB <Int32>]
    [-TrafficOutStopService <Boolean>]
    [-TrafficWarningPct <Int32>]
    [-VMInstanceCount <Int32>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Use this cmdlet to configure a cloud management gateway (CMG).

For more information, see CMG Overview.

Note

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

Examples

Example 1: Change the CMG alerts configuration

Set-CMCloudManagementGateway -Name "GraniteFalls" -EnableTrafficOut $true -TrafficOutGB 10000 -TrafficWarningPct 50 -TrafficCriticalPct 90 -EnableStorageQuota $true -StorageQuotaGB 2000 -StorageWarningPct 50 -StorageCriticalPct 90

Example 2: Change the number of virtual machines for the CMG service

This example targets the CMG named GraniteFalls and changes the number of VMs to 4.

Set-CMCloudManagementGateway -Name "GraniteFalls" -VMInstancesCount 4

Example 3: Enable the CMG to serve content from Azure storage

Set-CMCloudManagementGateway -Name "GraniteFalls" -EnableCloudDPFunction $true

Example 4: Add two new certificate authorities

$path1 = "folder\root.cer"
$type1 = [Microsoft.ConfigurationManagement.AdminConsole.AzureServices.CertificateStore]::RootCA

$path2 = "folder\intermediate.cer"
$type2 = [Microsoft.ConfigurationManagement.AdminConsole.AzureServices.CertificateStore]::IntermediateCA

$cert = @{$path1 = $type1; $path2 = $type2}

Set-CMCloudManagementGateway -Name "GraniteFalls" -CARootCert $cert

Example 5: Update the CMG server authentication certificate

This example targets the CMG named GraniteFalls and updates the CMG server authentication certificate.

Set-CMCloudManagementGateway -Name "GraniteFalls" -ServiceCertPath "c:\TestPath\NewServiceCert.pfx" -ServiceCertPassword (ConvertTo-SecureString -String "tX*xJ11Nuo^B" -AsPlainText -Force)

Example 6: Remove a root certificate from a CMG

Set-CMCloudManagementGateway -Name "GraniteFalls" -RemoveCertThumbprints "A7CBA0014DEF847593569D05003D5B96A1D6A627"

Parameters

-CARootCert

Add root certificates to the cloud service.

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False
Aliases:CARootCertificate, CARootCertificates

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CheckClientCertRevocation

Set this parameter to true to verify client certificate revocation. A certificate revocation list (CRL) must be publicly published for this verification to work. For more information, see Publish the certificate revocation list.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Description

Specify an optional description of this CMG service to better identify it.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisableWildcardHandling

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EnableCloudDPFunction

Applies to version 2010 and later. Enable or disable the option to Allow CMG to function as a cloud distribution point and serve content from Azure storage.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EnableStorageQuota

Applies to version 2010 and later. Enable or disable the option to Specify storage alert threshold.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EnableTrafficOut

Applies to version 2010 and later. Enable or disable the option to Turn on 14-day threshold and alerts for monitoring outbound data transfer.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EnforceProtocol

Applies to version 2010 and later. Enable or disable the option to Enforce TLS 1.2.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Force

Run the command without asking for confirmation. If the service certificate contains multiple DNS names, use this parameter to avoid warnings from the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ForceWildcardHandling

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Id

Specify the site's ID for the Azure service. The Id is the integer value stored in the site database for the service. For example, run the following SQL query, and look at the ID column: select * from Azure_CloudService.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzureServiceId

Parameter sets

SetById
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

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

Parameter properties

Type:IResultObject
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetByValue
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specify the name of the CMG to configure.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetByName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

Returns an object representing the item with which you're working. By default, this cmdlet may not generate any output.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RemoveCertThumbprints

Applies to version 2010 and later. Specify one or more certificate thumbprints to remove them as root or intermediate certificate authorities from the CMG.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ServiceCertPassword

Applies to version 2006 and later. Specify the password for the certificate in the -ServiceCertPath.

Parameter properties

Type:SecureString
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ServiceCertificatePassword

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ServiceCertPath

Applies to version 2006 and later. Specify the path to the service certificate. For more information, see CMG server authentication certificate.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ServiceCertificatePath

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-StorageCriticalPct

Applies to version 2010 and later. Specify an integer value for the Generate Critical alert (% of storage alert threshold). For example, 90.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:StorageCriticalPercent

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-StorageQuotaGB

Applies to version 2010 and later. Specify an integer value for the Storage alert threshold (GB). For example, 2.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-StorageWarningPct

Applies to version 2010 and later. Specify an integer value for the Generate Warning alert (% of storage alert threshold). For example, 50.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:StorageWarningPercent

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TrafficCriticalPct

If you enable alerts for monitoring outbound data transfer, specify the percentage of threshold for raising a Critical alert. This value is 90 by default.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TrafficOutGB

If you enable storage alerts, use this parameter to specify the storage alert threshold in GB. The default value is 2.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TrafficOutStopService

Applies to version 2010 and later. Enable or disable the option to Stop this service when the critical threshold is exceeded.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:StopTrafficOutService

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TrafficWarningPct

If you enable alerts for monitoring outbound data transfer, specify the percentage of threshold for raising a Warning alert. This value is 50 by default.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VMInstanceCount

Applies to version 2010 and later. Specify the instance count of virtual machines.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:VMInstancesCount

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

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

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object