Edit

Share via

Set-CMCertificateProfileScep

Module:
ConfigurationManager Module

Sets a SCEP certificate profile.

Syntax

ByValue (Default) 

Set-CMCertificateProfileScep
    -InputObject <IResultObject>
    [-AllowCertificateOnAnyDevice <Boolean>]
    [-CertificateStore <CertificateStoreType>]
    [-CertificateTemplateName <String>]
    [-CertificateValidityDays <Int32>]
    [-Description <String>]
    [-Eku <Hashtable>]
    [-EnrollmentRenewThresholdPct <Int32>]
    [-EnrollmentRetryCount <Int32>]
    [-EnrollmentRetryDelayMins <Int32>]
    [-HashAlgorithm <HashAlgorithmTypes>]
    [-KeySize <Int32>]
    [-KeyStorageProvider <KeyStorageProviderSettingType>]
    [-KeyUsage <X509KeyUsageFlags>]
    [-NewName <String>]
    [-PassThru]
    [-RequireMultifactor <Boolean>]
    [-RootCertificate <IResultObject>]
    [-SanType <SubjectAlternativeNameFormatTypes>]
    [-ScepServerUrl <String[]>]
    [-SubjectType <SubjectNameFormatTypes>]
    [-SupportedPlatform <IResultObject[]>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ById 

Set-CMCertificateProfileScep
    -Id <Int32>
    [-AllowCertificateOnAnyDevice <Boolean>]
    [-CertificateStore <CertificateStoreType>]
    [-CertificateTemplateName <String>]
    [-CertificateValidityDays <Int32>]
    [-Description <String>]
    [-Eku <Hashtable>]
    [-EnrollmentRenewThresholdPct <Int32>]
    [-EnrollmentRetryCount <Int32>]
    [-EnrollmentRetryDelayMins <Int32>]
    [-HashAlgorithm <HashAlgorithmTypes>]
    [-KeySize <Int32>]
    [-KeyStorageProvider <KeyStorageProviderSettingType>]
    [-KeyUsage <X509KeyUsageFlags>]
    [-NewName <String>]
    [-PassThru]
    [-RequireMultifactor <Boolean>]
    [-RootCertificate <IResultObject>]
    [-SanType <SubjectAlternativeNameFormatTypes>]
    [-ScepServerUrl <String[]>]
    [-SubjectType <SubjectNameFormatTypes>]
    [-SupportedPlatform <IResultObject[]>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByName 

Set-CMCertificateProfileScep
    -Name <String>
    [-AllowCertificateOnAnyDevice <Boolean>]
    [-CertificateStore <CertificateStoreType>]
    [-CertificateTemplateName <String>]
    [-CertificateValidityDays <Int32>]
    [-Description <String>]
    [-Eku <Hashtable>]
    [-EnrollmentRenewThresholdPct <Int32>]
    [-EnrollmentRetryCount <Int32>]
    [-EnrollmentRetryDelayMins <Int32>]
    [-HashAlgorithm <HashAlgorithmTypes>]
    [-KeySize <Int32>]
    [-KeyStorageProvider <KeyStorageProviderSettingType>]
    [-KeyUsage <X509KeyUsageFlags>]
    [-NewName <String>]
    [-PassThru]
    [-RequireMultifactor <Boolean>]
    [-RootCertificate <IResultObject>]
    [-SanType <SubjectAlternativeNameFormatTypes>]
    [-ScepServerUrl <String[]>]
    [-SubjectType <SubjectNameFormatTypes>]
    [-SupportedPlatform <IResultObject[]>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Set-CMCertificateProfileScep cmdlet updates the settings of a SCEP certificate profile.

Note

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

Examples

Example 1: Set a SCEP certificate profile by name

PS XYZ:\> Set-CMCertificateProfileScep -Name "TestProfile01" -CertificateStore Machine -Description "Test update" -HashAlgorithm SHA3 -KeySize 1024 -KeyUsage KeyEncipherment -NewName "TestProfile01_updated" -SanType SubjectAltRequireDns

This command updates the SEP certificate profile named TestProfile01 and gives it the new name TestProfile01_updated.

Example 2: Set a SCEP certificate profile by using the pipeline

PS XYZ:\> Get-CMCertificateProfileScep -Name "TestProfile02" -Fast | Set-CMCertificateProfileScep -AllowCertificateOnAnyDevice $True -KeyStorageProvider InstallToNGC_FailIfNotPresent

This command gets the SEP certificate profile object named TestProfile02 and uses the pipeline operator to pass the object to Set-CMCertificateProfileScep, which updates the settings of the profile object.

Parameters

-AllowCertificateOnAnyDevice

Indicates whether to allow certificate enrollment on any device.

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

-CertificateStore

Specifies the certificate type. Valid values are:

  • Machine
  • User

Parameter properties

Type:CertificateStoreType
Default value:None
Accepted values:Machine, User
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

-CertificateTemplateName

Specifies the name of a certificate template.

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

-CertificateValidityDays

Specifies, in number of days, the certificate validity period.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
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

Specifies a description for the SCEP certificate profile.

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

-Eku

Specifies the extended key usage. The values in the hash table define the certificate's intended purpose.

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Ekus

Parameter sets

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

-EnrollmentRenewThresholdPct

Specifies the percentage of the certificate lifetime that remains before the device requests renewal of the certificate.

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

-EnrollmentRetryCount

Specifies the number of times that the device automatically retries the certificate request to the server that is running the Network Device Enrollment Service.

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

-EnrollmentRetryDelayMins

Specifies the interval, in minutes, between each enrollment attempt when you use CA manager approval before the issuing CA processes the certificate request.

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

-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

-HashAlgorithm

Specifies the hash algorithm. Valid values are:

  • SHA1
  • SHA2
  • SHA3
  • NONE

Parameter properties

Type:HashAlgorithmTypes
Default value:None
Accepted values:NONE, SHA1, SHA2, SHA3
Supports wildcards:False
DontShow:False
Aliases:HashAlgorithms

Parameter sets

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

-Id

Specifies the CI_ID of a SCEP certificate profile.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:CI_ID, CIId

Parameter sets

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

-InputObject

Specifies a SCEP certificate profile object. To obtain a SCEP certificate profile object, use the Get-CMCertificateProfileScep function.

Parameter properties

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

Parameter sets

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

-KeySize

Specifies the size of the key. Valid values are:

  • 1024
  • 2048

Parameter properties

Type:Int32
Default value:None
Accepted values:1024, 2048, 4096
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

-KeyStorageProvider

Specifies the Key Storage Provider (KSP) for the SCEP enrollment. Valid values are:

  • None
  • InstallToTPM_FailIfNotPresent
  • InstallToTPM_IfPresent
  • InstallToSoftwareKeyStorageProvider
  • InstallToNGC_FailIfNotPresent

Parameter properties

Type:KeyStorageProviderSettingType
Default value:None
Accepted values:None, InstallToTPM_FailIfNotPresent, InstallToTPM_IfPresent, InstallToSoftwareKeyStorageProvider, InstallToNGC_FailIfNotPresent
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

-KeyUsage

Specifies the key usage for the certificate. Valid values are:

  • KeyEncipherment
  • DigitalSignature
  • None
  • EncipherOnly
  • CrlSign
  • KeyCertSign
  • KeyAgreement
  • DataEncipherment
  • NonRepudiation
  • DecipherOnly

Parameter properties

Type:X509KeyUsageFlags
Default value:None
Accepted values:KeyEncipherment, DigitalSignature
Supports wildcards:False
DontShow:False
Aliases:KeyUsages

Parameter sets

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

-Name

Specifies a name for the SCEP certificate profile.

Parameter properties

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

Parameter sets

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

-NewName

Specifies a new name for the SCEP certificate profile.

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

-PassThru

Add this parameter to return an object that represents 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

-RequireMultifactor

Indicates that multi-factor authentication is required during enrollment of devices before issuing certificates to those devices. This parameter can be used when the InstallToNGC_FailIfNotPresent value is set for the KeyStorageProvider parameter.

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

-RootCertificate

Specifies a trusted root CA certificate object. To get a trusted root CA certificate, use the Get-CMCertificateProfileTrustedRootCA function.

Parameter properties

Type:IResultObject
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

-SanType

Specifies the subject alternative name. Valid values are:

  • SubjectAltRequireSpn
  • SubjectAltRequireUpn
  • SubjectAltReqiureEmail
  • SubjectAltRequireDns

Parameter properties

Type:SubjectAlternativeNameFormatTypes
Default value:None
Accepted values:SubjectAltRequireCustom, SubjectAltRequireSpn, SubjectAltRequireAAD, SubjectAltRequireUpn, SubjectAltReqiureEmail, SubjectAltRequireDns
Supports wildcards:False
DontShow:False
Aliases:SanTypes

Parameter sets

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

-ScepServerUrl

Specifies an array of URLs for the Network Device Enrollment Service (NDES) servers that will issue certificates via SCEP.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:ScepServerUrls

Parameter sets

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

-SubjectType

Specifies the subject name format. Valid values are:

  • SubjectRequireCommonNameAsEmail
  • SubjectRequireCommonNameAsDeviceName
  • SubjectRequireCommonNameAsOSName
  • SubjectRequireCommonNameAsIMEI
  • SubjectRequireCommonNameAsMEID
  • SubjectRequireCommonNameAsSerialNumber
  • SubjectRequireCommonNameAsDeviceType
  • SubjectRequireCommonNameAsWiFiMAC
  • SubjectRequireCommonNameAsEthernetMAC
  • SubjectRequireAsCustomString
  • SubjectRequireDnsAsCN
  • SubjectRequireEmail
  • SubjectRequireCommonName
  • SubjectRequireDirectoryPath

Parameter properties

Type:SubjectNameFormatTypes
Default value:None
Accepted values:SubjectRequireCommonNameAsEmail, SubjectRequireCommonNameAsDeviceName, SubjectRequireCommonNameAsOSName, SubjectRequireCommonNameAsIMEI, SubjectRequireCommonNameAsMEID, SubjectRequireCommonNameAsSerialNumber, SubjectRequireCommonNameAsDeviceType, SubjectRequireCommonNameAsWiFiMAC, SubjectRequireCommonNameAsEthernetMAC, SubjectRequireAsCustomString, SubjectRequireDnsAsCN, SubjectRequireEmail, SubjectRequireCommonName, SubjectRequireDirectoryPath
Supports wildcards:False
DontShow:False
Aliases:SubjectTypes

Parameter sets

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

-SupportedPlatform

Specifies a supported platform object. To obtain a supported platform object, use the Get-CMSupportedPlatform cmdlet.

Parameter properties

Type:

IResultObject[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:SupportedPlatforms

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:False
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

IResultObject