Edit

Add-ClusterSharedVolumeToAffinityRule

  • Reference
Module:
FailoverClusters

Adds a Cluster Shared Volume (CSV) to an existing affinity rule.

Syntax

Add-ClusterSharedVolumeToAffinityRule
   [[-Name] <String[]>]
   [-ClusterSharedVolumes] <String[]>
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [<CommonParameters>]
Add-ClusterSharedVolumeToAffinityRule
   -InputObject <CimInstance[]>
    [-ClusterSharedVolumes] <String[]>
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [<CommonParameters>]

Description

This cmdlet allows you to add cluster shared volumes (CSVs) to an existing affinity rule, using either the CSV name or object.

Examples

Example 1 - Add a CSV to an affinity rule

Add-ClusterSharedVolumeToAffinityRule -ClusterSharedVolumes MyVolume -Name MyRule -Cluster MyCluster

This command adds the cluster shared volume MyVolume to the affinity rule MyRule for the cluster MyCluster.

Example 2 - Add a CSV to an affinity rule using pipeline

Get-ClusterAffinityRule -name Rule1 |
 Add-ClusterSharedVolumeToAffinityRule -ClusterSharedVolumes Volume1

The command gets the affinity rule Rule1 object and passes it to the Add-ClusterSharedVolumeToAffinityRule command. The command adds the cluster shared volume Volume1 to the affinity rule.

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

-ClusterSharedVolumes

The cluster shared volumes to add to the affinity rule.

Type:String[]
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specifies the affinity rule object that is used in a pipeline command.

Type:CimInstance[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

The name of affinity rule to add cluster shared volumes to.

Type:String[]
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-PassThru

Returns the original affinity rule object passed to the command. By default, this cmdlet doesn't generate any output.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
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 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

Inputs

String[]

When a string is piped to this cmdlet, the value is used as the name of the affinity rule to add the cluster shared volume to.

CimInstance[]

This cmdlet accepts CIM instance objects representing an affinity rule like those returned by the Get-ClusterAffinityRule cmdlet.

Outputs

None

By default, the cmdlet doesn't return any output.

CimInstance

CimInstance

When the PassThru parameter is specified, the cmdlet returns an object representing an affinity rule as a CIM instance within the root/MSCLUSTER/MSCluster_AffinityRule path.