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;
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)
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
})
}
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,
};
});
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);
}
}
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}
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 string
- The unique name of the resource.
- args LiveToolsPingArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args LiveToolsPingArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args LiveToolsPingArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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",
});
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"),
})
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());
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")
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",
});
type: meraki:devices:LiveToolsPing
properties:
parameters:
callback:
httpServer:
id: string
payloadTemplate:
id: string
sharedSecret: string
url: string
count: 0
target: string
serial: string
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
Live
Tools Ping Parameters - Serial string
- serial path parameter.
- Parameters
Live
Tools Ping Parameters Args - Serial string
- serial path parameter.
- parameters
Live
Tools Ping Parameters - serial String
- serial path parameter.
- parameters
Live
Tools Ping Parameters - serial string
- serial path parameter.
- parameters
Live
Tools Ping Parameters Args - serial str
- serial path parameter.
- parameters Property Map
- serial 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
Live
Tools Ping Item
- Id string
- The provider-assigned unique ID for this managed resource.
- Item
Live
Tools Ping Item
- id String
- The provider-assigned unique ID for this managed resource.
- item
Live
Tools Ping Item
- id string
- The provider-assigned unique ID for this managed resource.
- item
Live
Tools Ping Item
- id str
- The provider-assigned unique ID for this managed resource.
- item
Live
Tools Ping Item
- 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)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
- Item
Live
Tools Ping Item - Parameters
Live
Tools Ping Parameters - Serial string
- serial path parameter.
- Item
Live
Tools Ping Item Args - Parameters
Live
Tools Ping Parameters Args - Serial string
- serial path parameter.
- item
Live
Tools Ping Item - parameters
Live
Tools Ping Parameters - serial String
- serial path parameter.
- item
Live
Tools Ping Item - parameters
Live
Tools Ping Parameters - serial string
- serial path parameter.
- item
Live
Tools Ping Item Args - parameters
Live
Tools Ping Parameters Args - serial str
- serial path parameter.
- item Property Map
- parameters Property Map
- serial String
- serial path parameter.
Supporting Types
LiveToolsPingItem, LiveToolsPingItemArgs
- Callback
Live
Tools Ping Item Callback - Information for callback used to send back results
- Ping
Id string - Id to check the status of your ping request.
- Request
Live
Tools Ping Item Request - Ping request parameters
- Status string
- Status of the ping request.
- Url string
- GET this url to check the status of your ping request.
- Callback
Live
Tools Ping Item Callback - Information for callback used to send back results
- Ping
Id string - Id to check the status of your ping request.
- Request
Live
Tools Ping Item Request - Ping request parameters
- Status string
- Status of the ping request.
- Url string
- GET this url to check the status of your ping request.
- callback
Live
Tools Ping Item Callback - Information for callback used to send back results
- ping
Id String - Id to check the status of your ping request.
- request
Live
Tools Ping Item Request - Ping request parameters
- status String
- Status of the ping request.
- url String
- GET this url to check the status of your ping request.
- callback
Live
Tools Ping Item Callback - Information for callback used to send back results
- ping
Id string - Id to check the status of your ping request.
- request
Live
Tools Ping Item Request - Ping request parameters
- status string
- Status of the ping request.
- url string
- GET this url to check the status of your ping request.
- callback
Live
Tools Ping Item Callback - Information for callback used to send back results
- ping_
id str - Id to check the status of your ping request.
- request
Live
Tools Ping Item Request - 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
- ping
Id 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
LiveToolsPingParameters, LiveToolsPingParametersArgs
- Callback
Live
Tools Ping Parameters Callback - 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
Live
Tools Ping Parameters Callback - 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
Live
Tools Ping Parameters Callback - 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
Live
Tools Ping Parameters Callback - 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
Live
Tools Ping Parameters Callback - 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
- Http
Server LiveTools Ping Parameters Callback Http Server - The webhook receiver used for the callback webhook.
- Payload
Template LiveTools Ping Parameters Callback Payload Template - The payload template of the webhook used for the callback
- 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 LiveTools Ping Parameters Callback Http Server - The webhook receiver used for the callback webhook.
- Payload
Template LiveTools Ping Parameters Callback Payload Template - The payload template of the webhook used for the callback
- 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 LiveTools Ping Parameters Callback Http Server - The webhook receiver used for the callback webhook.
- payload
Template LiveTools Ping Parameters Callback Payload Template - The payload template of the webhook used for the callback
- 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 LiveTools Ping Parameters Callback Http Server - The webhook receiver used for the callback webhook.
- payload
Template LiveTools Ping Parameters Callback Payload Template - The payload template of the webhook used for the callback
- 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 LiveTools Ping Parameters Callback Http Server - The webhook receiver used for the callback webhook.
- payload_
template LiveTools Ping Parameters Callback Payload Template - The payload template of the webhook used for the callback
- 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.
- http
Server Property Map - The webhook receiver used for the callback webhook.
- payload
Template Property Map - The payload template of the webhook used for the callback
- 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"
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.