< Back

Get-OVGDAppliance

Mon Jan 13, 2020 8:50 pm

NAME Get-OVGDAppliance



SYNOPSIS

Retrieves appliances connected to the Global Dashboard instance





SYNTAX

Get-OVGDAppliance [-Server <Object>] [-Id <Object>] [-Count <Object>] [<CommonParameters>]



Get-OVGDAppliance [-Server <Object>] [-Id <Object>] [-ApplianceName <Object>] [-ApplianceLocation <Object>]

[-Status <Object>] [-State <Object>] [-UserQuery <Object>] [-Count <Object>] [<CommonParameters>]



Get-OVGDAppliance [-Server <Object>] [-Id <Object>] [<CommonParameters>]





DESCRIPTION

This function will retrieve the appliances connected to the specified Global Dashboard instance





PARAMETERS

-Server <Object>

The Global Dashboard to retrieve appliances from



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Id <Object>

The Id of the Appliance to retrieve



Required? false

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-ApplianceName <Object>

Filter on ApplianceName of Appliance to retrieve. Note that we search for an exact match



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ApplianceLocation <Object>

Filter on ApplianceLocation of Appliance to retrieve. Note that we search for an exact match



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Status <Object>

Filter on Status of Appliance to retrieve. Note that we search for an exact match



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-State <Object>

Filter on State of Appliance to retrieve. Note that we search for an exact match



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-UserQuery <Object>

Query string used for full text search



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Count <Object>

The count of appliances to retrieve, defaults to 25



Required? false

Position? named

Default value 25

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES





Info

Author : Rudi Martinsen / Intility AS

Date : 25/03-2019

Version : 0.5.0

Revised : 25/04-2019

Changelog:

0.5.0 -- Reworked output

0.4.0 -- Changed Entity parameter to Id, adding Name alias

0.3.1 -- Updated help text

0.3.0 -- Added support for querying, changed text when result is bigger than count

0.2.2 -- Fixed minor bug in help text, added link

0.2.1 -- Added help text

0.2.0 -- Added count param



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



PS C:\\>Get-OVGDAppliance



Retrieves all OneView appliances connected to the Global Dashboard instance









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



PS C:\\>Get-OVGDAppliance -ApplianceName Appliance01



Searches for a OneView Appliance with the specified Appliance Name









-------------------------- EXAMPLE 3 --------------------------



PS C:\\>Get-OVGDAppliance -UserQuery "c7000 Enclosure G3"



Performs a full text search and matches all attributes for the specified string











RELATED LINKS

https://github.com/rumart/GlobalDashboardPS

https://developer.hpe.com/blog/accessin ... hboard-api

https://rudimartinsen.com/2019/04/23/hp ... ll-module/