Cisco Meraki v0.2.4, Jun 14 24

Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi

meraki.devices.getLiveToolsPing

Explore with Pulumi AI

Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi

Example Usage

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

const example = meraki.devices.getLiveToolsPing({
    id: "string",
    serial: "string",
});
export const merakiDevicesLiveToolsPingExample = example.then(example => example.item);

import pulumi
import pulumi_meraki as meraki

example = meraki.devices.get_live_tools_ping(id="string",
    serial="string")
pulumi.export("merakiDevicesLiveToolsPingExample", example.item)

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.LookupLiveToolsPing(ctx, &devices.LookupLiveToolsPingArgs{
			Id:     "string",
			Serial: "string",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("merakiDevicesLiveToolsPingExample", example.Item)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Meraki = Pulumi.Meraki;

return await Deployment.RunAsync(() => 
{
    var example = Meraki.Devices.GetLiveToolsPing.Invoke(new()
    {
        Id = "string",
        Serial = "string",
    });

    return new Dictionary<string, object?>
    {
        ["merakiDevicesLiveToolsPingExample"] = example.Apply(getLiveToolsPingResult => getLiveToolsPingResult.Item),
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.meraki.devices.DevicesFunctions;
import com.pulumi.meraki.devices.inputs.GetLiveToolsPingArgs;
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) {
        final var example = DevicesFunctions.getLiveToolsPing(GetLiveToolsPingArgs.builder()
            .id("string")
            .serial("string")
            .build());

        ctx.export("merakiDevicesLiveToolsPingExample", example.applyValue(getLiveToolsPingResult -> getLiveToolsPingResult.item()));
    }
}

variables:
  example:
    fn::invoke:
      Function: meraki:devices:getLiveToolsPing
      Arguments:
        id: string
        serial: string
outputs:
  merakiDevicesLiveToolsPingExample: ${example.item}

Using getLiveToolsPing

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getLiveToolsPing(args: GetLiveToolsPingArgs, opts?: InvokeOptions): Promise<GetLiveToolsPingResult>
function getLiveToolsPingOutput(args: GetLiveToolsPingOutputArgs, opts?: InvokeOptions): Output<GetLiveToolsPingResult>

def get_live_tools_ping(id: Optional[str] = None,
                        serial: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetLiveToolsPingResult
def get_live_tools_ping_output(id: Optional[pulumi.Input[str]] = None,
                        serial: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetLiveToolsPingResult]

func LookupLiveToolsPing(ctx *Context, args *LookupLiveToolsPingArgs, opts ...InvokeOption) (*LookupLiveToolsPingResult, error)
func LookupLiveToolsPingOutput(ctx *Context, args *LookupLiveToolsPingOutputArgs, opts ...InvokeOption) LookupLiveToolsPingResultOutput

> Note: This function is named LookupLiveToolsPing in the Go SDK.

public static class GetLiveToolsPing 
{
    public static Task<GetLiveToolsPingResult> InvokeAsync(GetLiveToolsPingArgs args, InvokeOptions? opts = null)
    public static Output<GetLiveToolsPingResult> Invoke(GetLiveToolsPingInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetLiveToolsPingResult> getLiveToolsPing(GetLiveToolsPingArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: meraki:devices/getLiveToolsPing:getLiveToolsPing
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: id path parameter.
Serial string: serial path parameter.

Id string: id path parameter.
Serial string: serial path parameter.

id String: id path parameter.
serial String: serial path parameter.

id string: id path parameter.
serial string: serial path parameter.

id str: id path parameter.
serial str: serial path parameter.

id String: id path parameter.
serial String: serial path parameter.

getLiveToolsPing Result

The following output properties are available:

Id string: id path parameter.
Item GetLiveToolsPingItem
Serial string: serial path parameter.

Id string: id path parameter.
Item GetLiveToolsPingItem
Serial string: serial path parameter.

id String: id path parameter.
item GetLiveToolsPingItem
serial String: serial path parameter.

id string: id path parameter.
item GetLiveToolsPingItem
serial string: serial path parameter.

id str: id path parameter.
item GetLiveToolsPingItem
serial str: serial path parameter.

id String: id path parameter.
item Property Map
serial String: serial path parameter.

Supporting Types

GetLiveToolsPingItem

PingId string: Id to check the status of your ping request.
Request GetLiveToolsPingItemRequest: Ping request parameters
Results GetLiveToolsPingItemResults: Results of the ping request.
Status string: Status of the ping request.
Url string: GET this url to check the status of your ping request.

PingId string: Id to check the status of your ping request.
Request GetLiveToolsPingItemRequest: Ping request parameters
Results GetLiveToolsPingItemResults: Results of the ping request.
Status string: Status of the ping request.
Url string: GET this url to check the status of your ping request.

pingId String: Id to check the status of your ping request.
request GetLiveToolsPingItemRequest: Ping request parameters
results GetLiveToolsPingItemResults: Results of the ping request.
status String: Status of the ping request.
url String: GET this url to check the status of your ping request.

pingId string: Id to check the status of your ping request.
request GetLiveToolsPingItemRequest: Ping request parameters
results GetLiveToolsPingItemResults: Results of the ping request.
status string: Status of the ping request.
url string: GET this url to check the status of your ping request.

ping_id str: Id to check the status of your ping request.
request GetLiveToolsPingItemRequest: Ping request parameters
results GetLiveToolsPingItemResults: Results of the ping request.
status str: Status of the ping request.
url str: GET this url to check the status of your ping request.

pingId String: Id to check the status of your ping request.
request Property Map: Ping request parameters
results Property Map: Results of the ping request.
status String: Status of the ping request.
url String: GET this url to check the status of your ping request.

GetLiveToolsPingItemRequest

CountR int: Number of pings to send
Serial string: Device serial number
Target string: IP address or FQDN to ping

CountR int: Number of pings to send
Serial string: Device serial number
Target string: IP address or FQDN to ping

countR Integer: Number of pings to send
serial String: Device serial number
target String: IP address or FQDN to ping

countR number: Number of pings to send
serial string: Device serial number
target string: IP address or FQDN to ping

count_r int: Number of pings to send
serial str: Device serial number
target str: IP address or FQDN to ping

countR Number: Number of pings to send
serial String: Device serial number
target String: IP address or FQDN to ping

GetLiveToolsPingItemResults

Latencies GetLiveToolsPingItemResultsLatencies: Packet latency stats
Loss GetLiveToolsPingItemResultsLoss: Lost packets
Received int: Number of packets received
Replies List<GetLiveToolsPingItemResultsReply>: Received packets
Sent int: Number of packets sent

Latencies GetLiveToolsPingItemResultsLatencies: Packet latency stats
Loss GetLiveToolsPingItemResultsLoss: Lost packets
Received int: Number of packets received
Replies []GetLiveToolsPingItemResultsReply: Received packets
Sent int: Number of packets sent

latencies GetLiveToolsPingItemResultsLatencies: Packet latency stats
loss GetLiveToolsPingItemResultsLoss: Lost packets
received Integer: Number of packets received
replies List<GetLiveToolsPingItemResultsReply>: Received packets
sent Integer: Number of packets sent

latencies GetLiveToolsPingItemResultsLatencies: Packet latency stats
loss GetLiveToolsPingItemResultsLoss: Lost packets
received number: Number of packets received
replies GetLiveToolsPingItemResultsReply[]: Received packets
sent number: Number of packets sent

latencies GetLiveToolsPingItemResultsLatencies: Packet latency stats
loss GetLiveToolsPingItemResultsLoss: Lost packets
received int: Number of packets received
replies Sequence[GetLiveToolsPingItemResultsReply]: Received packets
sent int: Number of packets sent

latencies Property Map: Packet latency stats
loss Property Map: Lost packets
received Number: Number of packets received
replies List<Property Map>: Received packets
sent Number: Number of packets sent

GetLiveToolsPingItemResultsLatencies

Average double: Average latency
Maximum double: Maximum latency
Minimum double: Minimum latency

Average float64: Average latency
Maximum float64: Maximum latency
Minimum float64: Minimum latency

average Double: Average latency
maximum Double: Maximum latency
minimum Double: Minimum latency

average number: Average latency
maximum number: Maximum latency
minimum number: Minimum latency

average float: Average latency
maximum float: Maximum latency
minimum float: Minimum latency

average Number: Average latency
maximum Number: Maximum latency
minimum Number: Minimum latency

GetLiveToolsPingItemResultsLoss

Percentage double: Percentage of packets lost

Percentage float64: Percentage of packets lost

percentage Double: Percentage of packets lost

percentage number: Percentage of packets lost

percentage float: Percentage of packets lost

percentage Number: Percentage of packets lost

GetLiveToolsPingItemResultsReply

Latency double: Latency of the packet in milliseconds
SequenceId int: Sequence ID of the packet
Size int: Size of the packet in bytes

Latency float64: Latency of the packet in milliseconds
SequenceId int: Sequence ID of the packet
Size int: Size of the packet in bytes

latency Double: Latency of the packet in milliseconds
sequenceId Integer: Sequence ID of the packet
size Integer: Size of the packet in bytes

latency number: Latency of the packet in milliseconds
sequenceId number: Sequence ID of the packet
size number: Size of the packet in bytes

latency float: Latency of the packet in milliseconds
sequence_id int: Sequence ID of the packet
size int: Size of the packet in bytes

latency Number: Latency of the packet in milliseconds
sequenceId Number: Sequence ID of the packet
size Number: Size of the packet in bytes

Package Details

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

Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi

pulumi/pulumi-meraki

meraki.devices.getLiveToolsPing

On this page

On this page

Example Usage

Using getLiveToolsPing

getLiveToolsPing Result

Supporting Types

GetLiveToolsPingItem

GetLiveToolsPingItemRequest

GetLiveToolsPingItemResults

GetLiveToolsPingItemResultsLatencies

GetLiveToolsPingItemResultsLoss

GetLiveToolsPingItemResultsReply

Package Details

On this page

On this page