Get GrafanaDashboard

---

external help file: PSGrafana-help.xml Module Name: PSGrafana online version: schema: 2.0.0

Get-GrafanaDashboard

SYNOPSIS

Returns an object with details about a Grafana dashboard

SYNTAX

Name

Get-GrafanaDashboard [[-Name] <String>] [-IncludeMetadata] [<CommonParameters>]

Uuid

Get-GrafanaDashboard [[-Uuid] <String>] [-IncludeMetadata] [<CommonParameters>]

Tag

Get-GrafanaDashboard [[-Tag] <String>] [-IncludeMetadata] [<CommonParameters>]

DESCRIPTION

EXAMPLES

EXAMPLE 1

Get-GrafanaDashboard -Name 'Prod - FileServer'

EXAMPLE 2

Get-GrafanaDashboard -Uuid O0E3f5t

EXAMPLE 3

Get-GrafanaDashboard -Name 'Smiley' -IncudeMetadata

PARAMETERS

-Name

Search the Grafana instance for dashboards by friendly name

Type: String
Parameter Sets: Name
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Uuid

Search the Grafana instance for dashboards by UID

Type: String
Parameter Sets: Uuid
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Tag

Search the Grafana instance for dashboards by Tag

Type: String
Parameter Sets: Tag
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IncludeMetadata

Include extra metadata about the dashboard. Excluded by default.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

RELATED LINKS

Remove-GrafanaDashboard, Set-GrafanaDashboard