Edit

Get-FsrmMgmtProperty

  • Reference
Module:
FileServerResourceManager

Gets management properties.

Syntax

Get-FsrmMgmtProperty
   [-Namespace <String>]
   [-Name <String>]
   [-Recurse]
   [-Effective]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Get-FsrmMgmtProperty cmdlet gets File Server Resource Manager (FSRM) management properties for a namespace. A management property is a classification property that includes Folder in its AppliesTo property and whose Flags property does not include the Secure value. You can use the Get-FsrmClassificationPropertyDefinition cmdlet to get definitions of classification properties.

Examples

Example 1: Get all management properties

PS C:\> Get-FsrmMgmtProperty

This command gets all management properties for the server.

Example 2: Get management properties by using a namespace

PS C:\> Get-FsrmMgmtProperty -Namespace "C:\Shares"

This command gets the Folder Usage property for the folder C:\Shares.

Example 3: Get management properties by using a name

PS C:\> Get-FsrmMgmtProperty -Namespace "C:\Shares" -Name "FolderUsage_MS"

This command gets the Folder Usage property for the management property named FolderUsage_MS in the folder C:\Shares.

Example 4: Get management properties for all folders in a path

PS C:\> Get-FsrmMgmtProperty -Namespace "C:\Shares" -Recurse

This command gets management properties for C:\Shares and for all folders within the path.

Example 5: Get the nearest management properties by using a name

PS C:\> Get-FsrmMgmtProperty -Namespace "C:\Shares\CtrShares03" -Name "FolderUsage_MS" -Effective

This command gets the FolderUsage property value on C:\Shares\CtrShares03. If the folder usage management property named FolderUsage_MS is not set on C:\Shares\CtrShares03, the cmdlet searches up through the namespace (C:\shares, C:\) and finds the first occurrence of the management property.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet.

For more information about Windows PowerShell background jobs, see about_Jobs.

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

-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Effective

Indicates that the cmdlet gets the management property for the nearest folder that has the name that you specify. The cmdlet finds the nearest management property based on the namespace that you specify or the parent hierarchy. If you specify this parameter, you must specify the Name parameter.

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

-Name

Specifies the name of a management property. Specify the value of the Name property in a FsrmClassificationPropertyDefinition object. If you do not specify this parameter, the cmdlet gets all management properties on the server.

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

-Namespace

Specifies a local path to a folder.

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

-Recurse

Indicates that this cmdlet gets management properties for all folders that contain management properties in the namespace. If you specify this parameter, you must specify the Namespace parameter.

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

-ThrottleLimit

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

SwitchParameter

Outputs

CimInstance[]