< Back
Get-OVGDEnclosure
Post
NAME Get-OVGDEnclosure
SYNOPSIS
Retrieves Enclosures connected to the Global Dashboard instance
SYNTAX
Get-OVGDEnclosure [-Server <Object>] [-Count <Object>] [<CommonParameters>]
Get-OVGDEnclosure [-Server <Object>] [-EnclosureName <Object>] [-SerialNumber <Object>] [-Appliance <Object>]
[-Type <Object>] [-Status <Object>] [-State <Object>] [-UserQuery <Object>] [-Count <Object>] [<CommonParameters>]
Get-OVGDEnclosure [-Server <Object>] [-Id <Object>] [<CommonParameters>]
DESCRIPTION
This function will retrieve the Enclosures on the specified Global Dashboard instance
PARAMETERS
-Server <Object>
The Global Dashboard to retrieve Enclosures from
Required? false
Position? named
Default value $Global:OVGDPSServer
Accept pipeline input? false
Accept wildcard characters? false
-Id <Object>
The Id of the Enclosure to retrieve
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EnclosureName <Object>
Filter on the Name of Enclosure to retrieve. Note that we search for an exact match
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SerialNumber <Object>
Filter on SerialNumber of Enclosure to retrieve. Note that we search for an exact match
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Appliance <Object>
Filter on Appliance of Enclosure to retrieve. Note that we search for an exact match
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Type <Object>
Filter on EnclosureType of Enclosure 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 Enclosure 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 Enclosure 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 Enclosure 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.4.0
Revised : 25/04-2019
Changelog:
0.4.0 -- Reworked output
0.3.0 -- Changed Entity parameter to Id, adding Name alias
0.2.0 -- Added support for querying, changed warning text when result is bigger than count
0.1.2 -- Fixed bug in help text and added link
0.1.1 -- Added help text
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-OVGDEnclosure
Retrieves all Enclosures connected to the Global Dashboard instance
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-OVGDEnclosure -Id xxxxxxxx-xxxx-xxxx-xxxx-54e195f27f36
Retrieves the specific Enclosure with the specified ID
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-OVGDEnclosure -EnclosureName Encl1
Searches for a Enclosure with the specified Enclosure Name
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-OVGDEnclosure -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/
SYNOPSIS
Retrieves Enclosures connected to the Global Dashboard instance
SYNTAX
Get-OVGDEnclosure [-Server <Object>] [-Count <Object>] [<CommonParameters>]
Get-OVGDEnclosure [-Server <Object>] [-EnclosureName <Object>] [-SerialNumber <Object>] [-Appliance <Object>]
[-Type <Object>] [-Status <Object>] [-State <Object>] [-UserQuery <Object>] [-Count <Object>] [<CommonParameters>]
Get-OVGDEnclosure [-Server <Object>] [-Id <Object>] [<CommonParameters>]
DESCRIPTION
This function will retrieve the Enclosures on the specified Global Dashboard instance
PARAMETERS
-Server <Object>
The Global Dashboard to retrieve Enclosures from
Required? false
Position? named
Default value $Global:OVGDPSServer
Accept pipeline input? false
Accept wildcard characters? false
-Id <Object>
The Id of the Enclosure to retrieve
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EnclosureName <Object>
Filter on the Name of Enclosure to retrieve. Note that we search for an exact match
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SerialNumber <Object>
Filter on SerialNumber of Enclosure to retrieve. Note that we search for an exact match
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Appliance <Object>
Filter on Appliance of Enclosure to retrieve. Note that we search for an exact match
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Type <Object>
Filter on EnclosureType of Enclosure 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 Enclosure 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 Enclosure 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 Enclosure 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.4.0
Revised : 25/04-2019
Changelog:
0.4.0 -- Reworked output
0.3.0 -- Changed Entity parameter to Id, adding Name alias
0.2.0 -- Added support for querying, changed warning text when result is bigger than count
0.1.2 -- Fixed bug in help text and added link
0.1.1 -- Added help text
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-OVGDEnclosure
Retrieves all Enclosures connected to the Global Dashboard instance
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-OVGDEnclosure -Id xxxxxxxx-xxxx-xxxx-xxxx-54e195f27f36
Retrieves the specific Enclosure with the specified ID
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-OVGDEnclosure -EnclosureName Encl1
Searches for a Enclosure with the specified Enclosure Name
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-OVGDEnclosure -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/