Search HPOVIndex - HewlettPackard/POSH-HPEOneView GitHub Wiki

HPE OneView 4.10 Library

Search-HPOVIndex

Search the resource index.

SYNTAX

Search-HPOVIndex [-Search] <String> [-Category] <String> [-Count] <Int32> [-Start] <Int32> [-ApplianceConnection] <Object> [<CommonParameters>]

Detailed Description

Search the resource index for any objects that match the specified search string or category

Parameters

-ApplianceConnection <Object>

Aliases [-Appliance]

Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s).

Default Value: ${Global:ConnectedSessions} | ? Default

Aliases	Appliance
Required?	true
Position?	4
Default value	(${Global:ConnectedSessions} \| ? Default)
Accept pipeline input?	false
Accept wildcard characters?	False

-Category <String>

The resource category to be matched, if specified. Valid resource categories are:

* domains
* users
* racks
* enclosure-groups
* enclosures
* uplink-sets
* logical-interconnect-groups
* logical-interconnects
* interconnect-types
* interconnects
* networks
* firmware-drivers
* server-hardware-types
* server-hardware
* server-profiles
* alerts
* storage-volumes
* storage-systems

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

-Count <Int32>

The maximum number of resource index entries to be returned. Defaults to 50.

Aliases	None
Required?	true
Position?	2
Default value	50
Accept pipeline input?	false
Accept wildcard characters?	False

-Search <String>

The search query, text to be found in the index.

Aliases	None
Required?	true
Position?	0
Default value
Accept pipeline input?	false
Accept wildcard characters?	False

-Start <Int32>

The index of the first resource index to be returned, defaults to 0.

Aliases	None
Required?	true
Position?	3
Default value	0
Accept pipeline input?	false
Accept wildcard characters?	False

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)

Input Types

None. You cannot pipe objects to this cmdlet.

Return Values

System.Collections.ArrayList

The matching index entries

Examples

-------------------------- EXAMPLE 1 --------------------------

Search-HPOVIndex "Profile1"

Return all the index entries which include this string.

-------------------------- EXAMPLE 2 --------------------------

Search-HPOVIndex -categroy uplink-sets

Search for all Uplink Set resources.

HPE OneView 4.00 Library