< Back

Suspend-DDHost

Sat Jan 18, 2020 8:13 pm

NAME Suspend-DDHost



SYNOPSIS

Mutes Datadog hosts.





SYNTAX

Suspend-DDHost [-Hostname] <String> [[-Message] <String>] [[-Override]] [-WhatIf] [-Confirm] [<CommonParameters>]



Suspend-DDHost [-Hostname] <String> [[-Message] <String>] [[-EndTimestamp] <Double>] [[-Override]] [-WhatIf]

[-Confirm] [<CommonParameters>]



Suspend-DDHost [-Hostname] <String> [[-Message] <String>] [[-EndDate] <DateTime>] [[-Override]] [-WhatIf]

[-Confirm] [<CommonParameters>]





DESCRIPTION





PARAMETERS

-Hostname <String>

A hostname as shown on Datadog's Infrastructure List



Required? true

Position? 1

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-Message <String>

A message to associate with the muting of this host



Required? false

Position? 2

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-EndTimestamp <Double>

POSIX timestamp when the host will be unmuted. If omitted, the host will remain muted until explicitly unmuted.



Required? false

Position? 3

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-EndDate <DateTime>

A Datetime object representing when the mute should end. If omitted, the host will remain muted until

explicitly unmuted.



Required? false

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Override [<SwitchParameter>]

If true and the host is already muted, will replace existing host mute settings.



Required? false

Position? 4

Default value False

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]



Required? false

Position? named

Default value

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



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



PS C:\\># Mute a host called myhost, undefinitely



Suspend-DDHost -Hostname myhost









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



PS C:\\># Mute a host for 1h using a Datetime object



Suspend-DDMonitor -Hostname myhost -EndDate (get-date).AddHours(1)









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



PS C:\\># Mute a host for 1h using a Unix timestamp



Suspend-DDMonitor -Hostname myhost -EndTimestamp 1473358000









-------------------------- EXAMPLE 4 --------------------------



PS C:\\># Mute a host, provide an informationnal message and override an existing muting



Suspend-DDMonitor -Hostname myhost -Message 'Shutting down this server' -Override











RELATED LINKS

http://docs.datadoghq.com/api/?lang=console#hosts-mute