1. Packages
  2. Meraki Provider
  3. API Docs
  4. devices
  5. getLiveToolsPingDevice
Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi

meraki.devices.getLiveToolsPingDevice

Explore with Pulumi AI

meraki logo
Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as meraki from "@pulumi/meraki";
    
    const example = meraki.devices.getLiveToolsPingDevice({
        id: "string",
        serial: "string",
    });
    export const merakiDevicesLiveToolsPingDeviceExample = example.then(example => example.item);
    
    import pulumi
    import pulumi_meraki as meraki
    
    example = meraki.devices.get_live_tools_ping_device(id="string",
        serial="string")
    pulumi.export("merakiDevicesLiveToolsPingDeviceExample", 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.LookupLiveToolsPingDevice(ctx, &devices.LookupLiveToolsPingDeviceArgs{
    			Id:     "string",
    			Serial: "string",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("merakiDevicesLiveToolsPingDeviceExample", 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.GetLiveToolsPingDevice.Invoke(new()
        {
            Id = "string",
            Serial = "string",
        });
    
        return new Dictionary<string, object?>
        {
            ["merakiDevicesLiveToolsPingDeviceExample"] = example.Apply(getLiveToolsPingDeviceResult => getLiveToolsPingDeviceResult.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.GetLiveToolsPingDeviceArgs;
    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.getLiveToolsPingDevice(GetLiveToolsPingDeviceArgs.builder()
                .id("string")
                .serial("string")
                .build());
    
            ctx.export("merakiDevicesLiveToolsPingDeviceExample", example.applyValue(getLiveToolsPingDeviceResult -> getLiveToolsPingDeviceResult.item()));
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: meraki:devices:getLiveToolsPingDevice
          Arguments:
            id: string
            serial: string
    outputs:
      merakiDevicesLiveToolsPingDeviceExample: ${example.item}
    

    Using getLiveToolsPingDevice

    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 getLiveToolsPingDevice(args: GetLiveToolsPingDeviceArgs, opts?: InvokeOptions): Promise<GetLiveToolsPingDeviceResult>
    function getLiveToolsPingDeviceOutput(args: GetLiveToolsPingDeviceOutputArgs, opts?: InvokeOptions): Output<GetLiveToolsPingDeviceResult>
    def get_live_tools_ping_device(id: Optional[str] = None,
                                   serial: Optional[str] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetLiveToolsPingDeviceResult
    def get_live_tools_ping_device_output(id: Optional[pulumi.Input[str]] = None,
                                   serial: Optional[pulumi.Input[str]] = None,
                                   opts: Optional[InvokeOptions] = None) -> Output[GetLiveToolsPingDeviceResult]
    func LookupLiveToolsPingDevice(ctx *Context, args *LookupLiveToolsPingDeviceArgs, opts ...InvokeOption) (*LookupLiveToolsPingDeviceResult, error)
    func LookupLiveToolsPingDeviceOutput(ctx *Context, args *LookupLiveToolsPingDeviceOutputArgs, opts ...InvokeOption) LookupLiveToolsPingDeviceResultOutput

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

    public static class GetLiveToolsPingDevice 
    {
        public static Task<GetLiveToolsPingDeviceResult> InvokeAsync(GetLiveToolsPingDeviceArgs args, InvokeOptions? opts = null)
        public static Output<GetLiveToolsPingDeviceResult> Invoke(GetLiveToolsPingDeviceInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetLiveToolsPingDeviceResult> getLiveToolsPingDevice(GetLiveToolsPingDeviceArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: meraki:devices/getLiveToolsPingDevice:getLiveToolsPingDevice
      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.

    getLiveToolsPingDevice Result

    The following output properties are available:

    Id string
    id path parameter.
    Item GetLiveToolsPingDeviceItem
    Serial string
    serial path parameter.
    Id string
    id path parameter.
    Item GetLiveToolsPingDeviceItem
    Serial string
    serial path parameter.
    id String
    id path parameter.
    item GetLiveToolsPingDeviceItem
    serial String
    serial path parameter.
    id string
    id path parameter.
    item GetLiveToolsPingDeviceItem
    serial string
    serial path parameter.
    id str
    id path parameter.
    item GetLiveToolsPingDeviceItem
    serial str
    serial path parameter.
    id String
    id path parameter.
    item Property Map
    serial String
    serial path parameter.

    Supporting Types

    GetLiveToolsPingDeviceItem

    Callback GetLiveToolsPingDeviceItemCallback
    Information for callback used to send back results
    PingId string
    Id to check the status of your ping request.
    Request GetLiveToolsPingDeviceItemRequest
    Ping request parameters
    Results GetLiveToolsPingDeviceItemResults
    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.
    Callback GetLiveToolsPingDeviceItemCallback
    Information for callback used to send back results
    PingId string
    Id to check the status of your ping request.
    Request GetLiveToolsPingDeviceItemRequest
    Ping request parameters
    Results GetLiveToolsPingDeviceItemResults
    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.
    callback GetLiveToolsPingDeviceItemCallback
    Information for callback used to send back results
    pingId String
    Id to check the status of your ping request.
    request GetLiveToolsPingDeviceItemRequest
    Ping request parameters
    results GetLiveToolsPingDeviceItemResults
    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.
    callback GetLiveToolsPingDeviceItemCallback
    Information for callback used to send back results
    pingId string
    Id to check the status of your ping request.
    request GetLiveToolsPingDeviceItemRequest
    Ping request parameters
    results GetLiveToolsPingDeviceItemResults
    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.
    callback GetLiveToolsPingDeviceItemCallback
    Information for callback used to send back results
    ping_id str
    Id to check the status of your ping request.
    request GetLiveToolsPingDeviceItemRequest
    Ping request parameters
    results GetLiveToolsPingDeviceItemResults
    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.
    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
    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.

    GetLiveToolsPingDeviceItemCallback

    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

    GetLiveToolsPingDeviceItemRequest

    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

    GetLiveToolsPingDeviceItemResults

    Latencies GetLiveToolsPingDeviceItemResultsLatencies
    Packet latency stats
    Loss GetLiveToolsPingDeviceItemResultsLoss
    Lost packets
    Received int
    Number of packets received
    Replies List<GetLiveToolsPingDeviceItemResultsReply>
    Received packets
    Sent int
    Number of packets sent
    Latencies GetLiveToolsPingDeviceItemResultsLatencies
    Packet latency stats
    Loss GetLiveToolsPingDeviceItemResultsLoss
    Lost packets
    Received int
    Number of packets received
    Replies []GetLiveToolsPingDeviceItemResultsReply
    Received packets
    Sent int
    Number of packets sent
    latencies GetLiveToolsPingDeviceItemResultsLatencies
    Packet latency stats
    loss GetLiveToolsPingDeviceItemResultsLoss
    Lost packets
    received Integer
    Number of packets received
    replies List<GetLiveToolsPingDeviceItemResultsReply>
    Received packets
    sent Integer
    Number of packets sent
    latencies GetLiveToolsPingDeviceItemResultsLatencies
    Packet latency stats
    loss GetLiveToolsPingDeviceItemResultsLoss
    Lost packets
    received number
    Number of packets received
    replies GetLiveToolsPingDeviceItemResultsReply[]
    Received packets
    sent number
    Number of packets sent
    latencies GetLiveToolsPingDeviceItemResultsLatencies
    Packet latency stats
    loss GetLiveToolsPingDeviceItemResultsLoss
    Lost packets
    received int
    Number of packets received
    replies Sequence[GetLiveToolsPingDeviceItemResultsReply]
    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

    GetLiveToolsPingDeviceItemResultsLatencies

    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

    GetLiveToolsPingDeviceItemResultsLoss

    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

    GetLiveToolsPingDeviceItemResultsReply

    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.
    meraki logo
    Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi