powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Search-Cloud



NAME
Search-Cloud

SYNOPSIS
Searches the cloud for objects of the specified type.

SYNTAX
Search-Cloud [-Name ] [[-Filter] ] [-QueryType] [-Property ] [-Server rver[]>] []


DESCRIPTION
Searches the cloud for objects of the specified type. You can filter the returned objects by their properties. The
cmdlet allows you to retrieve only specific properties of object.


PARAMETERS
-Name
Specify the names of the objects to search for. This parameter supports only the "*" wildcard. For more informa
tion about the valid filter syntax, see the vCloud API Programming Guide.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true

-Filter
Specify a filter criteria for the returned objects.

Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? true

-QueryType
Specify what types of objects you want to search for.

Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Property
Specify the properties you want to retrieve for the specified object type. If you don't provide a value for thi
s parameter, the cmdlet returns all properties of the objects.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Server
Specify the cloud servers on which you want to run the cmdlet. If no value is given to this parameter, the comm
and runs on the default servers. For more information about default servers, see the description of Connect-CIS
erver.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
CISearchResult


NOTES




-------------- Example 1 --------------

C:\PS>Search-Cloud -QueryType adminVAppTemplate


Searches the cloud server for virtual appliance templates. The user is connected as a cloud administrator.





-------------- Example 2 --------------

C:\PS>Search-Cloud -Type vAppTemplate


Searches the cloud server for virtual appliance templates. The user is connected as a cloud user.





-------------- Example 3 --------------

C:\PS>Search-Cloud user -Name User1


Searches for a user by name.





-------------- Example 4 --------------

C:\PS>Search-Cloud adminUser -Property 'Name', 'FullName'


Gets all the Name and FullName properties for all cloud users. You must be connected as a system administrator.





-------------- Example 5 --------------

C:\PS>Search-Cloud vappTemplate -Filter 'isGoldMaster==True;isPublished==True'


Searches for public gold master vAppTemplate objects.






RELATED LINKS
Online version: http://www.vmware.com/support/developer/PowerCLI/PowerCLI501/html/Search-Cloud.html