Get-VAIOFilter Command | Vmware PowerCLI Reference

Get-VAIOFilter

This cmdlet returns a list of VAIOFilter objects filtered by the specified parameters. If no parameters are specified, the cmdlet returns all filters installed on all default servers.

Syntax

Get-VAIOFilter
[-Cluster < Cluster[] > ]
[-Name < String[] > ]
[-Server < VIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional Cluster Cluster[] named
  • pipeline
  • wildcards
 Specifies the clusters on which to search for VAIO filters.
optional Name String[] named
  • wildcards
 Specifies the name of the VAIO filter you want to retrieve.
optional Server VIServer[] named
  • wildcards
 Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.
Get-VAIOFilter
-Id < String[] >
[-Server < VIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 Id String[] named
Filters the VAIO filters by ID. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list.
optional Server VIServer[] named
  • wildcards
 Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.

Output

VMware.VimAutomation.Storage.Types.V1.IoFilter.VAIOFilter

Examples

Example 1 

Get-VAIOFilter -Name "MyVAIOFilter"

Retrieves all VAIO filters named "MyVAIOFilter".

Example 2 

Get-VAIOFilter -Name "MyVAIOFilter" -Cluster $cluster

Retrieves the VAIO filter named "MyVAIOFilter" from the $cluster cluster.

Example 3 

Get-VAIOFilter -Id "MyVAIOFilterId"

Retrieves all VAIO filters with ID "MyVAIOFilterId".

Related Commands

VAIOFilter

This cmdlet returns a list of VAIOFilter objects filtered by the specified parameters.

This cmdlet installs a VAIO filter on the specified cluster.

This cmdlet uninstalls VAIO filters from the clusters on which they are installed.

This cmdlet upgrades a VAIO filter on the cluster it is installed.