pingdom::tcp-check

Creates a TCP Check.

Example

pingdom::tcp-check tcp-check-example
    name: "tcp-check-example"

    # TCP check specific attributes
    port: 80
    string-to-send: "GET / HTTP/1.0"
    string-to-expect: "200 OK"

    # Common check attributes
    resolution: 5
    hostname: "s7.mydomain.com"
    send-notification-when-down: 7
    notify-again-every: 4
    notify-when-back-up: true
    tags: ["abc", "xyz"]
end

Attributes

Attribute Description
name The name of the check. (Required)
hostname The target host of the check. (Required)
integration-ids list The list of integration identifiers. (Optional)
ipv6 Decides if ipv6 is used, rather than ipv4. (Optional)
notify-again-every Notify every x cycles. (Optional)
notify-when-back-up Decides if a notification is sent when the host is back up. (Optional)
paused Decides if check is paused. (Optional)
resolution Determines how often the host’s status is checked. (Optional)
response-time-threshold Triggers an alert if the response time is over this many ms. (Optional)
send-notification-when-down Determines if a notification is sent if the host goes down. (Optional)
tags set The tags for the check. (Optional)
team-ids list Ids of the teams that will be notified is the host is down. (Optional)
type The type of the check. (Required)
users list Users that will be notified is the host is down. (Optional)
probe-region Filter probe location. Valid values are North America (NA) or Europe (EU) or Asia Pacific (APAC) or Latin America (LATAM).
port The target port to connect to.
string-to-send A string to send once connected to the host.
string-to-expect String that should be in the response to consider check successful.

Outputs

Attribute Description
id The returned ID of the check.