vSphere PowerCLI Reference

Get-VAIOFilter

Synopsis

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

Syntax

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

Related Commands

Online version
New-VAIOFilter
Remove-VAIOFilter
Set-VAIOFilter

Detailed Description

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.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
NameString[]Specifies the name of the VAIO filter you want to retrieve.falsefalse
ClusterCluster[]Specifies the clusters on which to search for VAIO filters.falsetrue (ByValue)
IdString[]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.
truefalse
ServerVIServer[]Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.falsefalse

Return Type

Zero or more VAIOFilter objects

Notes

Works only with vCenter Server 6.0 or later.

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


Copyright © VMware, Inc. All rights reserved.