Edit

Share via


Add-CMObjectSecurityScope

Add a security scope to an object.

Syntax

ByValue (Default)

Add-CMObjectSecurityScope
    [-Scope] <IResultObject[]>
    -InputObject <IResultObject[]>
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ById

Add-CMObjectSecurityScope
    -Id <String>
    -InputObject <IResultObject[]>
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByName

Add-CMObjectSecurityScope
    [-Name] <String>
    -InputObject <IResultObject[]>
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Use this cmdlet to add a security scope to a Configuration Manager object.

For more information on security scopes, see Fundamentals of role-based administration in Configuration Manager.

Note

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

Examples

Example 1: Add a security scope to application objects

The first command creates a security scope object named Scope1 and stores it in the $Scope variable.

The second command gets all application objects whose name begins with "Central". It then uses the pipeline operator to pass the objects to Add-CMObjectSecurityScope. This cmdlet adds the security scope to each application object.

$Scope = New-CMSecurityScope -Name "Scope1" -Description "Security scope 1"
Get-CMApplication -Name "Central*" | Add-CMObjectSecurityScope -Scope $Scope

Parameters

-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

-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

-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 ID of a security scope to add to a Configuration Manager object. This value is the CategoryID property, for example SMS00UNA for the Default scope.

Parameter properties

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

Parameter sets

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

-InputObject

Specify an array of Configuration Manager objects to add the security scope. To get this object, use the Get cmdlet for the object type. For example, Get-CMApplication for app objects.

Parameter properties

Type:

IResultObject[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
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 a security scope to add to a Configuration Manager object.

Parameter properties

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

Parameter sets

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

-Scope

Specify an array of security scope objects to add. To get this object use the Get-CMSecurityScope cmdlet.

Parameter properties

Type:

IResultObject[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:SecurityScope, SecuredCategory, Scopes, SecurityScopes, SecuredCategories

Parameter sets

ByValue
Position:0
Mandatory:True
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

System.Object