Edit

Share via


Set-CMThirdPartyUpdateCatalog

Modify a third-party updates catalog.

Syntax

SearchByName (Default)

Set-CMThirdPartyUpdateCatalog
    [[-Name] <String>]
    [-Description <String>]
    [-Force]
    [-NewName <String>]
    [-PassThru]
    [-PublisherName <String>]
    [-Schedule <IResultObject>]
    [-Subscribe]
    [-SupportContact <String>]
    [-SupportUrl <Uri>]
    [-SyncNow]
    [-Unsubscribe]
    [-CategoryNamePublishOption <Hashtable>]
    [-CategoryIdPublishOption <Hashtable>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByIdMandatory

Set-CMThirdPartyUpdateCatalog
    [-Id] <String>
    [-Description <String>]
    [-Force]
    [-NewName <String>]
    [-PassThru]
    [-PublisherName <String>]
    [-Schedule <IResultObject>]
    [-Subscribe]
    [-SupportContact <String>]
    [-SupportUrl <Uri>]
    [-SyncNow]
    [-Unsubscribe]
    [-CategoryNamePublishOption <Hashtable>]
    [-CategoryIdPublishOption <Hashtable>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByValueMandatory

Set-CMThirdPartyUpdateCatalog
    [-InputObject] <IResultObject>
    [-Description <String>]
    [-Force]
    [-NewName <String>]
    [-PassThru]
    [-PublisherName <String>]
    [-Schedule <IResultObject>]
    [-Subscribe]
    [-SupportContact <String>]
    [-SupportUrl <Uri>]
    [-SyncNow]
    [-Unsubscribe]
    [-CategoryNamePublishOption <Hashtable>]
    [-CategoryIdPublishOption <Hashtable>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Use this cmdlet to modify a third-party updates catalog. For more information, see Enable third-party updates.

Note

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

Examples

Example 1: Rename a third-party update catalog

This example gets a third-party update catalog by name, and then changes the name.

Set-CMThirdPartyUpdateCatalog -Name "Contoso updates" -NewName "Contoso update catalog"

Example 2: Change the description

This example gets a third-party update catalog by object, and then changes the description.

Set-CMThirdPartyUpdateCatalog -ThirdPartyUpdateCatalog $catalog -Description "All of the current Contoso hardware updates"

Example 3: Change support information

This example gets a third-party update catalog piped on the command line, and then changes the support contact and URL.

$catalog | Set-CMThirdPartyUpdateCatalog -SupportContact "Contoso hardware support" -SupportUrl "https://hardware.contoso.com"

Example 4: Set the category publishing options for a v3 catalog

This example shows the syntax to create the hashtables to set the categories when you subscribe to a v3 catalog.

$id = "5768207d-6c40-465b-ad65-50501661368f"
$option = [Microsoft.ConfigurationManagement.Cmdlets.Sum.Commands.PublishOptionType]::MetadataOnly
$idOptionPair = @{$id = $option}
Set-CMThirdPartyUpdateCatalog -CatalogName 'pmp' -CategoryIdPublishOption $idOptionPair -Subscribe -Force

$name = "2BrightSparks"
$name1 = "8x8, Inc."
$option = [Microsoft.ConfigurationManagement.Cmdlets.Sum.Commands.PublishOptionType]::MetadataOnly
$nameOptionPair = @{$name = $option; $name1 = $option}
Set-CMThirdPartyUpdateCatalog -CatalogName 'pmp' -CategoryNamePublishOption $nameOptionPair -Subscribe -Force

Parameters

-CategoryIdPublishOption

Set the category ID publish option when you subscribe to a v3 catalog.

Parameter properties

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

-CategoryNamePublishOption

Set the category name publish option when you subscribe to a v3 catalog.

Parameter properties

Type:Hashtable
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 the description for the third-party updates catalog.

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

-Force

Run the command without asking for confirmation.

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. It's 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 ID of the third-party updates catalog to change.

Parameter properties

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

Parameter sets

SearchByIdMandatory
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Specify an object for the third-party updates catalog to change. To get this object, use the Get-CMThirdPartyUpdateCatalog cmdlet.

Parameter properties

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

Parameter sets

SearchByValueMandatory
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specify the name of the third-party updates catalog to change.

Parameter properties

Type:String
Default value:None
Supports wildcards:True
DontShow:False
Aliases:CatalogName

Parameter sets

SearchByName
Position:0
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NewName

Rename the selected third-party updates catalog.

Parameter properties

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

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

-PublisherName

Change the publisher name for the specified third-party updates catalog.

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

-Schedule

Specify a schedule object to apply to the specified third-party updates catalog. Custom schedules override the default synchronization schedule, and are only available for subscribed catalogs.

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

-Subscribe

Configure the site to subscribe to the third-party updates catalog. This parameter is the same as the console action to Subscribe to Catalog.

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

-SupportContact

Change the support contact for the specified third-party updates catalog.

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

-SupportUrl

Change the support URL for the specified third-party updates catalog.

Parameter properties

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

-SyncNow

Trigger the site to synchronize the specified third-party updates catalog. This parameter is the same as the console action to Sync now.

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

-Unsubscribe

Configure the site to unsubscribe from the third-party updates catalog. This parameter is the same as the console action to Unsubscribe from Catalog.

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

-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

IResultObject

Notes

This cmdlet returns an object of the SMS_ISVCatalogs WMI class.