1. Packages
  2. Cisco Meraki
  3. API Docs
  4. organizations
  5. getDevicesUplinksLossAndLatency
Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi

meraki.organizations.getDevicesUplinksLossAndLatency

Explore with Pulumi AI

meraki logo
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.organizations.getDevicesUplinksLossAndLatency({
        ip: "string",
        organizationId: "string",
        t0: "string",
        t1: "string",
        timespan: 1,
        uplink: "string",
    });
    export const merakiOrganizationsDevicesUplinksLossAndLatencyExample = example.then(example => example.items);
    
    import pulumi
    import pulumi_meraki as meraki
    
    example = meraki.organizations.get_devices_uplinks_loss_and_latency(ip="string",
        organization_id="string",
        t0="string",
        t1="string",
        timespan=1,
        uplink="string")
    pulumi.export("merakiOrganizationsDevicesUplinksLossAndLatencyExample", example.items)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-meraki/sdk/go/meraki/organizations"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := organizations.GetDevicesUplinksLossAndLatency(ctx, &organizations.GetDevicesUplinksLossAndLatencyArgs{
    			Ip:             pulumi.StringRef("string"),
    			OrganizationId: "string",
    			T0:             pulumi.StringRef("string"),
    			T1:             pulumi.StringRef("string"),
    			Timespan:       pulumi.Float64Ref(1),
    			Uplink:         pulumi.StringRef("string"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("merakiOrganizationsDevicesUplinksLossAndLatencyExample", example.Items)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Meraki = Pulumi.Meraki;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Meraki.Organizations.GetDevicesUplinksLossAndLatency.Invoke(new()
        {
            Ip = "string",
            OrganizationId = "string",
            T0 = "string",
            T1 = "string",
            Timespan = 1,
            Uplink = "string",
        });
    
        return new Dictionary<string, object?>
        {
            ["merakiOrganizationsDevicesUplinksLossAndLatencyExample"] = example.Apply(getDevicesUplinksLossAndLatencyResult => getDevicesUplinksLossAndLatencyResult.Items),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.meraki.organizations.OrganizationsFunctions;
    import com.pulumi.meraki.organizations.inputs.GetDevicesUplinksLossAndLatencyArgs;
    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 = OrganizationsFunctions.getDevicesUplinksLossAndLatency(GetDevicesUplinksLossAndLatencyArgs.builder()
                .ip("string")
                .organizationId("string")
                .t0("string")
                .t1("string")
                .timespan(1)
                .uplink("string")
                .build());
    
            ctx.export("merakiOrganizationsDevicesUplinksLossAndLatencyExample", example.applyValue(getDevicesUplinksLossAndLatencyResult -> getDevicesUplinksLossAndLatencyResult.items()));
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: meraki:organizations:getDevicesUplinksLossAndLatency
          Arguments:
            ip: string
            organizationId: string
            t0: string
            t1: string
            timespan: 1
            uplink: string
    outputs:
      merakiOrganizationsDevicesUplinksLossAndLatencyExample: ${example.items}
    

    Using getDevicesUplinksLossAndLatency

    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 getDevicesUplinksLossAndLatency(args: GetDevicesUplinksLossAndLatencyArgs, opts?: InvokeOptions): Promise<GetDevicesUplinksLossAndLatencyResult>
    function getDevicesUplinksLossAndLatencyOutput(args: GetDevicesUplinksLossAndLatencyOutputArgs, opts?: InvokeOptions): Output<GetDevicesUplinksLossAndLatencyResult>
    def get_devices_uplinks_loss_and_latency(ip: Optional[str] = None,
                                             organization_id: Optional[str] = None,
                                             t0: Optional[str] = None,
                                             t1: Optional[str] = None,
                                             timespan: Optional[float] = None,
                                             uplink: Optional[str] = None,
                                             opts: Optional[InvokeOptions] = None) -> GetDevicesUplinksLossAndLatencyResult
    def get_devices_uplinks_loss_and_latency_output(ip: Optional[pulumi.Input[str]] = None,
                                             organization_id: Optional[pulumi.Input[str]] = None,
                                             t0: Optional[pulumi.Input[str]] = None,
                                             t1: Optional[pulumi.Input[str]] = None,
                                             timespan: Optional[pulumi.Input[float]] = None,
                                             uplink: Optional[pulumi.Input[str]] = None,
                                             opts: Optional[InvokeOptions] = None) -> Output[GetDevicesUplinksLossAndLatencyResult]
    func GetDevicesUplinksLossAndLatency(ctx *Context, args *GetDevicesUplinksLossAndLatencyArgs, opts ...InvokeOption) (*GetDevicesUplinksLossAndLatencyResult, error)
    func GetDevicesUplinksLossAndLatencyOutput(ctx *Context, args *GetDevicesUplinksLossAndLatencyOutputArgs, opts ...InvokeOption) GetDevicesUplinksLossAndLatencyResultOutput

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

    public static class GetDevicesUplinksLossAndLatency 
    {
        public static Task<GetDevicesUplinksLossAndLatencyResult> InvokeAsync(GetDevicesUplinksLossAndLatencyArgs args, InvokeOptions? opts = null)
        public static Output<GetDevicesUplinksLossAndLatencyResult> Invoke(GetDevicesUplinksLossAndLatencyInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDevicesUplinksLossAndLatencyResult> getDevicesUplinksLossAndLatency(GetDevicesUplinksLossAndLatencyArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: meraki:organizations/getDevicesUplinksLossAndLatency:getDevicesUplinksLossAndLatency
      arguments:
        # arguments dictionary

    The following arguments are supported:

    OrganizationId string
    organizationId path parameter. Organization ID
    Ip string
    ip query parameter. Optional filter for a specific destination IP. Default will return all destination IPs.
    T0 string
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 60 days from today.
    T1 string
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 5 minutes after t0. The latest possible time that t1 can be is 2 minutes into the past.
    Timespan double
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 5 minutes. The default is 5 minutes.
    Uplink string
    uplink query parameter. Optional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, wan3, cellular. Default will return all uplinks.
    OrganizationId string
    organizationId path parameter. Organization ID
    Ip string
    ip query parameter. Optional filter for a specific destination IP. Default will return all destination IPs.
    T0 string
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 60 days from today.
    T1 string
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 5 minutes after t0. The latest possible time that t1 can be is 2 minutes into the past.
    Timespan float64
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 5 minutes. The default is 5 minutes.
    Uplink string
    uplink query parameter. Optional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, wan3, cellular. Default will return all uplinks.
    organizationId String
    organizationId path parameter. Organization ID
    ip String
    ip query parameter. Optional filter for a specific destination IP. Default will return all destination IPs.
    t0 String
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 60 days from today.
    t1 String
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 5 minutes after t0. The latest possible time that t1 can be is 2 minutes into the past.
    timespan Double
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 5 minutes. The default is 5 minutes.
    uplink String
    uplink query parameter. Optional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, wan3, cellular. Default will return all uplinks.
    organizationId string
    organizationId path parameter. Organization ID
    ip string
    ip query parameter. Optional filter for a specific destination IP. Default will return all destination IPs.
    t0 string
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 60 days from today.
    t1 string
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 5 minutes after t0. The latest possible time that t1 can be is 2 minutes into the past.
    timespan number
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 5 minutes. The default is 5 minutes.
    uplink string
    uplink query parameter. Optional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, wan3, cellular. Default will return all uplinks.
    organization_id str
    organizationId path parameter. Organization ID
    ip str
    ip query parameter. Optional filter for a specific destination IP. Default will return all destination IPs.
    t0 str
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 60 days from today.
    t1 str
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 5 minutes after t0. The latest possible time that t1 can be is 2 minutes into the past.
    timespan float
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 5 minutes. The default is 5 minutes.
    uplink str
    uplink query parameter. Optional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, wan3, cellular. Default will return all uplinks.
    organizationId String
    organizationId path parameter. Organization ID
    ip String
    ip query parameter. Optional filter for a specific destination IP. Default will return all destination IPs.
    t0 String
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 60 days from today.
    t1 String
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 5 minutes after t0. The latest possible time that t1 can be is 2 minutes into the past.
    timespan Number
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 5 minutes. The default is 5 minutes.
    uplink String
    uplink query parameter. Optional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, wan3, cellular. Default will return all uplinks.

    getDevicesUplinksLossAndLatency Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Items List<GetDevicesUplinksLossAndLatencyItem>
    Array of ResponseOrganizationsGetOrganizationDevicesUplinksLossAndLatency
    OrganizationId string
    organizationId path parameter. Organization ID
    Ip string
    ip query parameter. Optional filter for a specific destination IP. Default will return all destination IPs.
    T0 string
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 60 days from today.
    T1 string
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 5 minutes after t0. The latest possible time that t1 can be is 2 minutes into the past.
    Timespan double
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 5 minutes. The default is 5 minutes.
    Uplink string
    uplink query parameter. Optional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, wan3, cellular. Default will return all uplinks.
    Id string
    The provider-assigned unique ID for this managed resource.
    Items []GetDevicesUplinksLossAndLatencyItem
    Array of ResponseOrganizationsGetOrganizationDevicesUplinksLossAndLatency
    OrganizationId string
    organizationId path parameter. Organization ID
    Ip string
    ip query parameter. Optional filter for a specific destination IP. Default will return all destination IPs.
    T0 string
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 60 days from today.
    T1 string
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 5 minutes after t0. The latest possible time that t1 can be is 2 minutes into the past.
    Timespan float64
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 5 minutes. The default is 5 minutes.
    Uplink string
    uplink query parameter. Optional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, wan3, cellular. Default will return all uplinks.
    id String
    The provider-assigned unique ID for this managed resource.
    items List<GetDevicesUplinksLossAndLatencyItem>
    Array of ResponseOrganizationsGetOrganizationDevicesUplinksLossAndLatency
    organizationId String
    organizationId path parameter. Organization ID
    ip String
    ip query parameter. Optional filter for a specific destination IP. Default will return all destination IPs.
    t0 String
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 60 days from today.
    t1 String
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 5 minutes after t0. The latest possible time that t1 can be is 2 minutes into the past.
    timespan Double
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 5 minutes. The default is 5 minutes.
    uplink String
    uplink query parameter. Optional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, wan3, cellular. Default will return all uplinks.
    id string
    The provider-assigned unique ID for this managed resource.
    items GetDevicesUplinksLossAndLatencyItem[]
    Array of ResponseOrganizationsGetOrganizationDevicesUplinksLossAndLatency
    organizationId string
    organizationId path parameter. Organization ID
    ip string
    ip query parameter. Optional filter for a specific destination IP. Default will return all destination IPs.
    t0 string
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 60 days from today.
    t1 string
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 5 minutes after t0. The latest possible time that t1 can be is 2 minutes into the past.
    timespan number
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 5 minutes. The default is 5 minutes.
    uplink string
    uplink query parameter. Optional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, wan3, cellular. Default will return all uplinks.
    id str
    The provider-assigned unique ID for this managed resource.
    items Sequence[GetDevicesUplinksLossAndLatencyItem]
    Array of ResponseOrganizationsGetOrganizationDevicesUplinksLossAndLatency
    organization_id str
    organizationId path parameter. Organization ID
    ip str
    ip query parameter. Optional filter for a specific destination IP. Default will return all destination IPs.
    t0 str
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 60 days from today.
    t1 str
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 5 minutes after t0. The latest possible time that t1 can be is 2 minutes into the past.
    timespan float
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 5 minutes. The default is 5 minutes.
    uplink str
    uplink query parameter. Optional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, wan3, cellular. Default will return all uplinks.
    id String
    The provider-assigned unique ID for this managed resource.
    items List<Property Map>
    Array of ResponseOrganizationsGetOrganizationDevicesUplinksLossAndLatency
    organizationId String
    organizationId path parameter. Organization ID
    ip String
    ip query parameter. Optional filter for a specific destination IP. Default will return all destination IPs.
    t0 String
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 60 days from today.
    t1 String
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 5 minutes after t0. The latest possible time that t1 can be is 2 minutes into the past.
    timespan Number
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 5 minutes. The default is 5 minutes.
    uplink String
    uplink query parameter. Optional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, wan3, cellular. Default will return all uplinks.

    Supporting Types

    GetDevicesUplinksLossAndLatencyItem

    Ip string
    IP address of uplink
    NetworkId string
    Network ID
    Serial string
    Serial of MX device
    TimeSeries List<GetDevicesUplinksLossAndLatencyItemTimeSeries>
    Loss and latency timeseries data
    Uplink string
    Uplink interface (wan1, wan2, or cellular)
    Ip string
    IP address of uplink
    NetworkId string
    Network ID
    Serial string
    Serial of MX device
    TimeSeries []GetDevicesUplinksLossAndLatencyItemTimeSeries
    Loss and latency timeseries data
    Uplink string
    Uplink interface (wan1, wan2, or cellular)
    ip String
    IP address of uplink
    networkId String
    Network ID
    serial String
    Serial of MX device
    timeSeries List<GetDevicesUplinksLossAndLatencyItemTimeSeries>
    Loss and latency timeseries data
    uplink String
    Uplink interface (wan1, wan2, or cellular)
    ip string
    IP address of uplink
    networkId string
    Network ID
    serial string
    Serial of MX device
    timeSeries GetDevicesUplinksLossAndLatencyItemTimeSeries[]
    Loss and latency timeseries data
    uplink string
    Uplink interface (wan1, wan2, or cellular)
    ip str
    IP address of uplink
    network_id str
    Network ID
    serial str
    Serial of MX device
    time_series Sequence[GetDevicesUplinksLossAndLatencyItemTimeSeries]
    Loss and latency timeseries data
    uplink str
    Uplink interface (wan1, wan2, or cellular)
    ip String
    IP address of uplink
    networkId String
    Network ID
    serial String
    Serial of MX device
    timeSeries List<Property Map>
    Loss and latency timeseries data
    uplink String
    Uplink interface (wan1, wan2, or cellular)

    GetDevicesUplinksLossAndLatencyItemTimeSeries

    LatencyMs double
    Latency in milliseconds
    LossPercent double
    Loss percentage
    Ts string
    Timestamp for this data point
    LatencyMs float64
    Latency in milliseconds
    LossPercent float64
    Loss percentage
    Ts string
    Timestamp for this data point
    latencyMs Double
    Latency in milliseconds
    lossPercent Double
    Loss percentage
    ts String
    Timestamp for this data point
    latencyMs number
    Latency in milliseconds
    lossPercent number
    Loss percentage
    ts string
    Timestamp for this data point
    latency_ms float
    Latency in milliseconds
    loss_percent float
    Loss percentage
    ts str
    Timestamp for this data point
    latencyMs Number
    Latency in milliseconds
    lossPercent Number
    Loss percentage
    ts String
    Timestamp for this data point

    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.2.4 published on Friday, Jun 14, 2024 by Pulumi