Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Get-FsrmMgmtProperty

Windows Server 2012 R2 and Windows 8.1

Updated: January 7, 2014

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Get-FsrmMgmtProperty

Gets management properties.

Syntax

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




Detailed 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.

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CimSession<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.


Aliases

Session

Required?

false

Position?

named

Default Value

none

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Name<String>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

true

-Namespace<String>

Specifies a local path to a folder.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ThrottleLimit<Int32>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Get all management properties

This command gets all management properties for the server.


PS C:\> Get-FsrmMgmtProperty

Example 2: Get management properties by using a namespace

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


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

Example 3: Get management properties by using a name

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


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

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

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


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

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

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.


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

Related topics

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.