Search-Cloud
This cmdlet 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.
Syntax
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required
|
QueryType | QueryType | named |
|
Specifies what types of objects you want to search for. |
| optional | Filter | String | 1 |
|
Specifies a filter criteria for the returned objects. |
| optional | Name | String[] | named |
|
Specifies the names of the objects to search for. This parameter supports only the "*" wildcard. For more information about the valid filter syntax, see the vCloud API Programming Guide. |
| optional | ProgressAction | ActionPreference | named |
|
|
| optional | Property | String[] | named |
|
Specifies the properties you want to retrieve for the specified object type. If you do not provide a value for this parameter, the cmdlet returns all properties of the objects. |
| optional | Server | CIServer[] | named |
|
Specifies the cloud servers 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-CIServer. |
Output
VMware.VimAutomation.Cloud.Types.V1.CISearchResultExamples
Example 1
Search-Cloud -Type vAppTemplate
Searches the cloud server for virtual appliance templates. The user is connected as a cloud user.
Example 2
Search-Cloud user -Name User1
Searches for a user by name.
Example 3
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 4
Search-Cloud vappTemplate -Filter 'isGoldMaster==True;isPublished==True'
Searches for public gold master vAppTemplate objects.
Example 5
Search-Cloud -QueryType adminVAppTemplate
Searches the cloud server for virtual appliance templates. The user is connected as a cloud administrator.
Related Commands
Cloud
This cmdlet searches the cloud for objects of the specified type.