Skip to content

Set GrafanaDashboard

Stephen Valdinger edited this page Apr 9, 2019 · 1 revision

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

Set-GrafanaDashboard

SYNOPSIS

Update an existing Dashboard in Grafana

SYNTAX

Update (Default)

Set-GrafanaDashboard [-Title] <String> [[-NewTitle] <String>] [-Tags <String[]>] [<CommonParameters>]

id

Set-GrafanaDashboard -DashboardId <Int32> -DashboardUid <String> [<CommonParameters>]

DESCRIPTION

Change the title and tags of an existing Dashboard in Grafana

EXAMPLES

EXAMPLE 1

Set-GrafanaDashboard -Title "Boring Old Title" -NewTitle "Fancy New Title"

EXAMPLE 2

Set-GrafanaDashboard -Title "Boring Old Title" -NewTitle "Fancy New Title" -Tags "prod","wizz_bang"

EXAMPLE 3

Set-GrafanaDashboard -Title "Boring Old Title" -Tags "prod","apache" -DashboardId 35 -DashboardUid 5XWS256

PARAMETERS

-Title

The title of the dashboard you wish to modify

Type: String
Parameter Sets: Update
Aliases:

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

-NewTitle

The new title of the Dashboard if you wish to change it

Type: String
Parameter Sets: Update
Aliases:

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

-Tags

The updated tags. This overwrites existing tags

Type: String[]
Parameter Sets: Update
Aliases:

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

-DashboardId

If you know the dashboard ID, you may enter it

Type: Int32
Parameter Sets: id
Aliases:

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

-DashboardUid

If you know the dashboard Uid, you may enter it

Type: String
Parameter Sets: id
Aliases:

Required: True
Position: Named
Default value: None
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, Get-GrafanaDashboard

Clone this wiki locally