Get-FsrmMacro

Gets FSRM-supported macros.

Syntax

Get-FsrmMacro
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-Name <String[]>]
   [-ThrottleLimit <Int32>]
   [-Type <FsrmMacroTypeEnum[]>]
   [<CommonParameters>]

Description

The Get-FsrmMacro cmdlet gets one or more macros that File Server Resource Manager (FSRM) supports for configuration options. This cmdlet gets the FSRM-supported macros for the FSRM object that you specify in the Type parameter.

Examples

Example 1: Get FSRM-supported macros for quotas

PS C:\> Get-FsrmMacro -Type Quota

This command gets all the FSRM-supported macros for quotas.

Optional 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
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
Accept pipeline input:False
Accept wildcard characters:False
-Name

Specifies an array of macro names.

Type:String[]
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
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
Accept pipeline input:False
Accept wildcard characters:False
-Type

Specifies an array of FSRM object types. The acceptable values for this parameter are:

  • Quota
  • FileScreen
  • FileManagementJob
  • ADR
Type:FsrmMacroTypeEnum[]
Parameter Sets:Quota, FileScreen, FileManagementJob, Adr
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Outputs

Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMMacro