1. Packages
  2. Cisco Meraki Provider
  3. API Docs
  4. devices
  5. LiveToolsPing
Cisco Meraki v0.4.1 published on Saturday, Mar 15, 2025 by Pulumi

meraki.devices.LiveToolsPing

Explore with Pulumi AI

~>Warning: This resource does not represent a real-world entity in Meraki Dashboard, therefore changing or deleting this resource on its own has no immediate effect. Instead, it is a task part of a Meraki Dashboard workflow. It is executed in Meraki without any additional verification. It does not check if it was executed before or if a similar configuration or action already existed previously.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as meraki from "@pulumi/meraki";

const example = new meraki.devices.LiveToolsPing("example", {
    serial: "string",
    parameters: {
        callback: {
            httpServer: {
                id: "aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vd2ViaG9va3M=",
            },
            payloadTemplate: {
                id: "wpt_2100",
            },
            sharedSecret: "secret",
            url: "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031",
        },
        count: 2,
        target: "75.75.75.75",
    },
});
export const merakiDevicesLiveToolsPingExample = example;
Copy
import pulumi
import pulumi_meraki as meraki

example = meraki.devices.LiveToolsPing("example",
    serial="string",
    parameters={
        "callback": {
            "http_server": {
                "id": "aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vd2ViaG9va3M=",
            },
            "payload_template": {
                "id": "wpt_2100",
            },
            "shared_secret": "secret",
            "url": "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031",
        },
        "count": 2,
        "target": "75.75.75.75",
    })
pulumi.export("merakiDevicesLiveToolsPingExample", example)
Copy
package main

import (
	"github.com/pulumi/pulumi-meraki/sdk/go/meraki/devices"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := devices.NewLiveToolsPing(ctx, "example", &devices.LiveToolsPingArgs{
			Serial: pulumi.String("string"),
			Parameters: &devices.LiveToolsPingParametersArgs{
				Callback: &devices.LiveToolsPingParametersCallbackArgs{
					HttpServer: &devices.LiveToolsPingParametersCallbackHttpServerArgs{
						Id: pulumi.String("aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vd2ViaG9va3M="),
					},
					PayloadTemplate: &devices.LiveToolsPingParametersCallbackPayloadTemplateArgs{
						Id: pulumi.String("wpt_2100"),
					},
					SharedSecret: pulumi.String("secret"),
					Url:          pulumi.String("https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031"),
				},
				Count:  pulumi.Int(2),
				Target: pulumi.String("75.75.75.75"),
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("merakiDevicesLiveToolsPingExample", example)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Meraki = Pulumi.Meraki;

return await Deployment.RunAsync(() => 
{
    var example = new Meraki.Devices.LiveToolsPing("example", new()
    {
        Serial = "string",
        Parameters = new Meraki.Devices.Inputs.LiveToolsPingParametersArgs
        {
            Callback = new Meraki.Devices.Inputs.LiveToolsPingParametersCallbackArgs
            {
                HttpServer = new Meraki.Devices.Inputs.LiveToolsPingParametersCallbackHttpServerArgs
                {
                    Id = "aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vd2ViaG9va3M=",
                },
                PayloadTemplate = new Meraki.Devices.Inputs.LiveToolsPingParametersCallbackPayloadTemplateArgs
                {
                    Id = "wpt_2100",
                },
                SharedSecret = "secret",
                Url = "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031",
            },
            Count = 2,
            Target = "75.75.75.75",
        },
    });

    return new Dictionary<string, object?>
    {
        ["merakiDevicesLiveToolsPingExample"] = example,
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.meraki.devices.LiveToolsPing;
import com.pulumi.meraki.devices.LiveToolsPingArgs;
import com.pulumi.meraki.devices.inputs.LiveToolsPingParametersArgs;
import com.pulumi.meraki.devices.inputs.LiveToolsPingParametersCallbackArgs;
import com.pulumi.meraki.devices.inputs.LiveToolsPingParametersCallbackHttpServerArgs;
import com.pulumi.meraki.devices.inputs.LiveToolsPingParametersCallbackPayloadTemplateArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new LiveToolsPing("example", LiveToolsPingArgs.builder()
            .serial("string")
            .parameters(LiveToolsPingParametersArgs.builder()
                .callback(LiveToolsPingParametersCallbackArgs.builder()
                    .httpServer(LiveToolsPingParametersCallbackHttpServerArgs.builder()
                        .id("aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vd2ViaG9va3M=")
                        .build())
                    .payloadTemplate(LiveToolsPingParametersCallbackPayloadTemplateArgs.builder()
                        .id("wpt_2100")
                        .build())
                    .sharedSecret("secret")
                    .url("https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031")
                    .build())
                .count(2)
                .target("75.75.75.75")
                .build())
            .build());

        ctx.export("merakiDevicesLiveToolsPingExample", example);
    }
}
Copy
resources:
  example:
    type: meraki:devices:LiveToolsPing
    properties:
      serial: string
      parameters:
        callback:
          httpServer:
            id: aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vd2ViaG9va3M=
          payloadTemplate:
            id: wpt_2100
          sharedSecret: secret
          url: https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031
        count: 2
        target: 75.75.75.75
outputs:
  merakiDevicesLiveToolsPingExample: ${example}
Copy

Create LiveToolsPing Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new LiveToolsPing(name: string, args: LiveToolsPingArgs, opts?: CustomResourceOptions);
@overload
def LiveToolsPing(resource_name: str,
                  args: LiveToolsPingArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def LiveToolsPing(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  parameters: Optional[LiveToolsPingParametersArgs] = None,
                  serial: Optional[str] = None)
func NewLiveToolsPing(ctx *Context, name string, args LiveToolsPingArgs, opts ...ResourceOption) (*LiveToolsPing, error)
public LiveToolsPing(string name, LiveToolsPingArgs args, CustomResourceOptions? opts = null)
public LiveToolsPing(String name, LiveToolsPingArgs args)
public LiveToolsPing(String name, LiveToolsPingArgs args, CustomResourceOptions options)
type: meraki:devices:LiveToolsPing
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. LiveToolsPingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. LiveToolsPingArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. LiveToolsPingArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. LiveToolsPingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. LiveToolsPingArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var liveToolsPingResource = new Meraki.Devices.LiveToolsPing("liveToolsPingResource", new()
{
    Parameters = new Meraki.Devices.Inputs.LiveToolsPingParametersArgs
    {
        Callback = new Meraki.Devices.Inputs.LiveToolsPingParametersCallbackArgs
        {
            HttpServer = new Meraki.Devices.Inputs.LiveToolsPingParametersCallbackHttpServerArgs
            {
                Id = "string",
            },
            PayloadTemplate = new Meraki.Devices.Inputs.LiveToolsPingParametersCallbackPayloadTemplateArgs
            {
                Id = "string",
            },
            SharedSecret = "string",
            Url = "string",
        },
        Count = 0,
        Target = "string",
    },
    Serial = "string",
});
Copy
example, err := devices.NewLiveToolsPing(ctx, "liveToolsPingResource", &devices.LiveToolsPingArgs{
	Parameters: &devices.LiveToolsPingParametersArgs{
		Callback: &devices.LiveToolsPingParametersCallbackArgs{
			HttpServer: &devices.LiveToolsPingParametersCallbackHttpServerArgs{
				Id: pulumi.String("string"),
			},
			PayloadTemplate: &devices.LiveToolsPingParametersCallbackPayloadTemplateArgs{
				Id: pulumi.String("string"),
			},
			SharedSecret: pulumi.String("string"),
			Url:          pulumi.String("string"),
		},
		Count:  pulumi.Int(0),
		Target: pulumi.String("string"),
	},
	Serial: pulumi.String("string"),
})
Copy
var liveToolsPingResource = new LiveToolsPing("liveToolsPingResource", LiveToolsPingArgs.builder()
    .parameters(LiveToolsPingParametersArgs.builder()
        .callback(LiveToolsPingParametersCallbackArgs.builder()
            .httpServer(LiveToolsPingParametersCallbackHttpServerArgs.builder()
                .id("string")
                .build())
            .payloadTemplate(LiveToolsPingParametersCallbackPayloadTemplateArgs.builder()
                .id("string")
                .build())
            .sharedSecret("string")
            .url("string")
            .build())
        .count(0)
        .target("string")
        .build())
    .serial("string")
    .build());
Copy
live_tools_ping_resource = meraki.devices.LiveToolsPing("liveToolsPingResource",
    parameters={
        "callback": {
            "http_server": {
                "id": "string",
            },
            "payload_template": {
                "id": "string",
            },
            "shared_secret": "string",
            "url": "string",
        },
        "count": 0,
        "target": "string",
    },
    serial="string")
Copy
const liveToolsPingResource = new meraki.devices.LiveToolsPing("liveToolsPingResource", {
    parameters: {
        callback: {
            httpServer: {
                id: "string",
            },
            payloadTemplate: {
                id: "string",
            },
            sharedSecret: "string",
            url: "string",
        },
        count: 0,
        target: "string",
    },
    serial: "string",
});
Copy
type: meraki:devices:LiveToolsPing
properties:
    parameters:
        callback:
            httpServer:
                id: string
            payloadTemplate:
                id: string
            sharedSecret: string
            url: string
        count: 0
        target: string
    serial: string
Copy

LiveToolsPing Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The LiveToolsPing resource accepts the following input properties:

Parameters This property is required. LiveToolsPingParameters
Serial This property is required. string
serial path parameter.
Parameters This property is required. LiveToolsPingParametersArgs
Serial This property is required. string
serial path parameter.
parameters This property is required. LiveToolsPingParameters
serial This property is required. String
serial path parameter.
parameters This property is required. LiveToolsPingParameters
serial This property is required. string
serial path parameter.
parameters This property is required. LiveToolsPingParametersArgs
serial This property is required. str
serial path parameter.
parameters This property is required. Property Map
serial This property is required. String
serial path parameter.

Outputs

All input properties are implicitly available as output properties. Additionally, the LiveToolsPing resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Item LiveToolsPingItem
Id string
The provider-assigned unique ID for this managed resource.
Item LiveToolsPingItem
id String
The provider-assigned unique ID for this managed resource.
item LiveToolsPingItem
id string
The provider-assigned unique ID for this managed resource.
item LiveToolsPingItem
id str
The provider-assigned unique ID for this managed resource.
item LiveToolsPingItem
id String
The provider-assigned unique ID for this managed resource.
item Property Map

Look up Existing LiveToolsPing Resource

Get an existing LiveToolsPing resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: LiveToolsPingState, opts?: CustomResourceOptions): LiveToolsPing
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        item: Optional[LiveToolsPingItemArgs] = None,
        parameters: Optional[LiveToolsPingParametersArgs] = None,
        serial: Optional[str] = None) -> LiveToolsPing
func GetLiveToolsPing(ctx *Context, name string, id IDInput, state *LiveToolsPingState, opts ...ResourceOption) (*LiveToolsPing, error)
public static LiveToolsPing Get(string name, Input<string> id, LiveToolsPingState? state, CustomResourceOptions? opts = null)
public static LiveToolsPing get(String name, Output<String> id, LiveToolsPingState state, CustomResourceOptions options)
resources:  _:    type: meraki:devices:LiveToolsPing    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

Supporting Types

LiveToolsPingItem
, LiveToolsPingItemArgs

Callback LiveToolsPingItemCallback
Information for callback used to send back results
PingId string
Id to check the status of your ping request.
Request LiveToolsPingItemRequest
Ping request parameters
Status string
Status of the ping request.
Url string
GET this url to check the status of your ping request.
Callback LiveToolsPingItemCallback
Information for callback used to send back results
PingId string
Id to check the status of your ping request.
Request LiveToolsPingItemRequest
Ping request parameters
Status string
Status of the ping request.
Url string
GET this url to check the status of your ping request.
callback LiveToolsPingItemCallback
Information for callback used to send back results
pingId String
Id to check the status of your ping request.
request LiveToolsPingItemRequest
Ping request parameters
status String
Status of the ping request.
url String
GET this url to check the status of your ping request.
callback LiveToolsPingItemCallback
Information for callback used to send back results
pingId string
Id to check the status of your ping request.
request LiveToolsPingItemRequest
Ping request parameters
status string
Status of the ping request.
url string
GET this url to check the status of your ping request.
callback LiveToolsPingItemCallback
Information for callback used to send back results
ping_id str
Id to check the status of your ping request.
request LiveToolsPingItemRequest
Ping request parameters
status str
Status of the ping request.
url str
GET this url to check the status of your ping request.
callback Property Map
Information for callback used to send back results
pingId String
Id to check the status of your ping request.
request Property Map
Ping request parameters
status String
Status of the ping request.
url String
GET this url to check the status of your ping request.

LiveToolsPingItemCallback
, LiveToolsPingItemCallbackArgs

Id string
The ID of the callback. To check the status of the callback, use this ID in a request to /webhooks/callbacks/statuses/{id}
Status string
The status of the callback
Url string
The callback URL for the webhook target. This was either provided in the original request or comes from a configured webhook receiver
Id string
The ID of the callback. To check the status of the callback, use this ID in a request to /webhooks/callbacks/statuses/{id}
Status string
The status of the callback
Url string
The callback URL for the webhook target. This was either provided in the original request or comes from a configured webhook receiver
id String
The ID of the callback. To check the status of the callback, use this ID in a request to /webhooks/callbacks/statuses/{id}
status String
The status of the callback
url String
The callback URL for the webhook target. This was either provided in the original request or comes from a configured webhook receiver
id string
The ID of the callback. To check the status of the callback, use this ID in a request to /webhooks/callbacks/statuses/{id}
status string
The status of the callback
url string
The callback URL for the webhook target. This was either provided in the original request or comes from a configured webhook receiver
id str
The ID of the callback. To check the status of the callback, use this ID in a request to /webhooks/callbacks/statuses/{id}
status str
The status of the callback
url str
The callback URL for the webhook target. This was either provided in the original request or comes from a configured webhook receiver
id String
The ID of the callback. To check the status of the callback, use this ID in a request to /webhooks/callbacks/statuses/{id}
status String
The status of the callback
url String
The callback URL for the webhook target. This was either provided in the original request or comes from a configured webhook receiver

LiveToolsPingItemRequest
, LiveToolsPingItemRequestArgs

Count int
Number of pings to send
Serial string
Device serial number
Target string
IP address or FQDN to ping
Count int
Number of pings to send
Serial string
Device serial number
Target string
IP address or FQDN to ping
count Integer
Number of pings to send
serial String
Device serial number
target String
IP address or FQDN to ping
count number
Number of pings to send
serial string
Device serial number
target string
IP address or FQDN to ping
count int
Number of pings to send
serial str
Device serial number
target str
IP address or FQDN to ping
count Number
Number of pings to send
serial String
Device serial number
target String
IP address or FQDN to ping

LiveToolsPingParameters
, LiveToolsPingParametersArgs

Callback LiveToolsPingParametersCallback
Details for the callback. Please include either an httpServerId OR url and sharedSecret
Count int
Count parameter to pass to ping. [1..5], default 5
Target string
FQDN, IPv4 or IPv6 address
Callback LiveToolsPingParametersCallback
Details for the callback. Please include either an httpServerId OR url and sharedSecret
Count int
Count parameter to pass to ping. [1..5], default 5
Target string
FQDN, IPv4 or IPv6 address
callback LiveToolsPingParametersCallback
Details for the callback. Please include either an httpServerId OR url and sharedSecret
count Integer
Count parameter to pass to ping. [1..5], default 5
target String
FQDN, IPv4 or IPv6 address
callback LiveToolsPingParametersCallback
Details for the callback. Please include either an httpServerId OR url and sharedSecret
count number
Count parameter to pass to ping. [1..5], default 5
target string
FQDN, IPv4 or IPv6 address
callback LiveToolsPingParametersCallback
Details for the callback. Please include either an httpServerId OR url and sharedSecret
count int
Count parameter to pass to ping. [1..5], default 5
target str
FQDN, IPv4 or IPv6 address
callback Property Map
Details for the callback. Please include either an httpServerId OR url and sharedSecret
count Number
Count parameter to pass to ping. [1..5], default 5
target String
FQDN, IPv4 or IPv6 address

LiveToolsPingParametersCallback
, LiveToolsPingParametersCallbackArgs

HttpServer LiveToolsPingParametersCallbackHttpServer
The webhook receiver used for the callback webhook.
PayloadTemplate LiveToolsPingParametersCallbackPayloadTemplate
The payload template of the webhook used for the callback
SharedSecret string
A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
Url string
The callback URL for the webhook target. If using this field, please also specify a sharedSecret.
HttpServer LiveToolsPingParametersCallbackHttpServer
The webhook receiver used for the callback webhook.
PayloadTemplate LiveToolsPingParametersCallbackPayloadTemplate
The payload template of the webhook used for the callback
SharedSecret string
A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
Url string
The callback URL for the webhook target. If using this field, please also specify a sharedSecret.
httpServer LiveToolsPingParametersCallbackHttpServer
The webhook receiver used for the callback webhook.
payloadTemplate LiveToolsPingParametersCallbackPayloadTemplate
The payload template of the webhook used for the callback
sharedSecret String
A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
url String
The callback URL for the webhook target. If using this field, please also specify a sharedSecret.
httpServer LiveToolsPingParametersCallbackHttpServer
The webhook receiver used for the callback webhook.
payloadTemplate LiveToolsPingParametersCallbackPayloadTemplate
The payload template of the webhook used for the callback
sharedSecret string
A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
url string
The callback URL for the webhook target. If using this field, please also specify a sharedSecret.
http_server LiveToolsPingParametersCallbackHttpServer
The webhook receiver used for the callback webhook.
payload_template LiveToolsPingParametersCallbackPayloadTemplate
The payload template of the webhook used for the callback
shared_secret str
A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
url str
The callback URL for the webhook target. If using this field, please also specify a sharedSecret.
httpServer Property Map
The webhook receiver used for the callback webhook.
payloadTemplate Property Map
The payload template of the webhook used for the callback
sharedSecret String
A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
url String
The callback URL for the webhook target. If using this field, please also specify a sharedSecret.

LiveToolsPingParametersCallbackHttpServer
, LiveToolsPingParametersCallbackHttpServerArgs

Id string
The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.
Id string
The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.
id String
The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.
id string
The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.
id str
The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.
id String
The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.

LiveToolsPingParametersCallbackPayloadTemplate
, LiveToolsPingParametersCallbackPayloadTemplateArgs

Id string
The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.
Id string
The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.
id String
The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.
id string
The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.
id str
The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.
id String
The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.

Import

$ pulumi import meraki:devices/liveToolsPing:LiveToolsPing example "id,serial"
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
meraki pulumi/pulumi-meraki
License
Apache-2.0
Notes
This Pulumi package is based on the meraki Terraform Provider.