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

meraki.devices.getWirelessConnectionStats

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.getWirelessConnectionStats({
        apTag: "string",
        band: "string",
        serial: "string",
        ssid: 1,
        t0: "string",
        t1: "string",
        timespan: 1,
        vlan: 1,
    });
    export const merakiDevicesWirelessConnectionStatsExample = example.then(example => example.item);
    
    import pulumi
    import pulumi_meraki as meraki
    
    example = meraki.devices.get_wireless_connection_stats(ap_tag="string",
        band="string",
        serial="string",
        ssid=1,
        t0="string",
        t1="string",
        timespan=1,
        vlan=1)
    pulumi.export("merakiDevicesWirelessConnectionStatsExample", 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.GetWirelessConnectionStats(ctx, &devices.GetWirelessConnectionStatsArgs{
    			ApTag:    pulumi.StringRef("string"),
    			Band:     pulumi.StringRef("string"),
    			Serial:   "string",
    			Ssid:     pulumi.IntRef(1),
    			T0:       pulumi.StringRef("string"),
    			T1:       pulumi.StringRef("string"),
    			Timespan: pulumi.Float64Ref(1),
    			Vlan:     pulumi.IntRef(1),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("merakiDevicesWirelessConnectionStatsExample", 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.GetWirelessConnectionStats.Invoke(new()
        {
            ApTag = "string",
            Band = "string",
            Serial = "string",
            Ssid = 1,
            T0 = "string",
            T1 = "string",
            Timespan = 1,
            Vlan = 1,
        });
    
        return new Dictionary<string, object?>
        {
            ["merakiDevicesWirelessConnectionStatsExample"] = example.Apply(getWirelessConnectionStatsResult => getWirelessConnectionStatsResult.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.GetWirelessConnectionStatsArgs;
    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.getWirelessConnectionStats(GetWirelessConnectionStatsArgs.builder()
                .apTag("string")
                .band("string")
                .serial("string")
                .ssid(1)
                .t0("string")
                .t1("string")
                .timespan(1)
                .vlan(1)
                .build());
    
            ctx.export("merakiDevicesWirelessConnectionStatsExample", example.applyValue(getWirelessConnectionStatsResult -> getWirelessConnectionStatsResult.item()));
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: meraki:devices:getWirelessConnectionStats
          Arguments:
            apTag: string
            band: string
            serial: string
            ssid: 1
            t0: string
            t1: string
            timespan: 1
            vlan: 1
    outputs:
      merakiDevicesWirelessConnectionStatsExample: ${example.item}
    

    Using getWirelessConnectionStats

    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 getWirelessConnectionStats(args: GetWirelessConnectionStatsArgs, opts?: InvokeOptions): Promise<GetWirelessConnectionStatsResult>
    function getWirelessConnectionStatsOutput(args: GetWirelessConnectionStatsOutputArgs, opts?: InvokeOptions): Output<GetWirelessConnectionStatsResult>
    def get_wireless_connection_stats(ap_tag: Optional[str] = None,
                                      band: Optional[str] = None,
                                      serial: Optional[str] = None,
                                      ssid: Optional[int] = None,
                                      t0: Optional[str] = None,
                                      t1: Optional[str] = None,
                                      timespan: Optional[float] = None,
                                      vlan: Optional[int] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetWirelessConnectionStatsResult
    def get_wireless_connection_stats_output(ap_tag: Optional[pulumi.Input[str]] = None,
                                      band: Optional[pulumi.Input[str]] = None,
                                      serial: Optional[pulumi.Input[str]] = None,
                                      ssid: Optional[pulumi.Input[int]] = None,
                                      t0: Optional[pulumi.Input[str]] = None,
                                      t1: Optional[pulumi.Input[str]] = None,
                                      timespan: Optional[pulumi.Input[float]] = None,
                                      vlan: Optional[pulumi.Input[int]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetWirelessConnectionStatsResult]
    func GetWirelessConnectionStats(ctx *Context, args *GetWirelessConnectionStatsArgs, opts ...InvokeOption) (*GetWirelessConnectionStatsResult, error)
    func GetWirelessConnectionStatsOutput(ctx *Context, args *GetWirelessConnectionStatsOutputArgs, opts ...InvokeOption) GetWirelessConnectionStatsResultOutput

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

    public static class GetWirelessConnectionStats 
    {
        public static Task<GetWirelessConnectionStatsResult> InvokeAsync(GetWirelessConnectionStatsArgs args, InvokeOptions? opts = null)
        public static Output<GetWirelessConnectionStatsResult> Invoke(GetWirelessConnectionStatsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetWirelessConnectionStatsResult> getWirelessConnectionStats(GetWirelessConnectionStatsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: meraki:devices/getWirelessConnectionStats:getWirelessConnectionStats
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Serial string
    serial path parameter.
    ApTag string
    apTag query parameter. Filter results by AP Tag
    Band string
    band query parameter. Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.
    Ssid int
    ssid query parameter. Filter results by SSID
    T0 string
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 180 days from today.
    T1 string
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 7 days after t0.
    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 7 days.
    Vlan int
    vlan query parameter. Filter results by VLAN
    Serial string
    serial path parameter.
    ApTag string
    apTag query parameter. Filter results by AP Tag
    Band string
    band query parameter. Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.
    Ssid int
    ssid query parameter. Filter results by SSID
    T0 string
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 180 days from today.
    T1 string
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 7 days after t0.
    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 7 days.
    Vlan int
    vlan query parameter. Filter results by VLAN
    serial String
    serial path parameter.
    apTag String
    apTag query parameter. Filter results by AP Tag
    band String
    band query parameter. Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.
    ssid Integer
    ssid query parameter. Filter results by SSID
    t0 String
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 180 days from today.
    t1 String
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 7 days after t0.
    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 7 days.
    vlan Integer
    vlan query parameter. Filter results by VLAN
    serial string
    serial path parameter.
    apTag string
    apTag query parameter. Filter results by AP Tag
    band string
    band query parameter. Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.
    ssid number
    ssid query parameter. Filter results by SSID
    t0 string
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 180 days from today.
    t1 string
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 7 days after t0.
    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 7 days.
    vlan number
    vlan query parameter. Filter results by VLAN
    serial str
    serial path parameter.
    ap_tag str
    apTag query parameter. Filter results by AP Tag
    band str
    band query parameter. Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.
    ssid int
    ssid query parameter. Filter results by SSID
    t0 str
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 180 days from today.
    t1 str
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 7 days after t0.
    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 7 days.
    vlan int
    vlan query parameter. Filter results by VLAN
    serial String
    serial path parameter.
    apTag String
    apTag query parameter. Filter results by AP Tag
    band String
    band query parameter. Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.
    ssid Number
    ssid query parameter. Filter results by SSID
    t0 String
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 180 days from today.
    t1 String
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 7 days after t0.
    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 7 days.
    vlan Number
    vlan query parameter. Filter results by VLAN

    getWirelessConnectionStats Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Item GetWirelessConnectionStatsItem
    Serial string
    serial path parameter.
    ApTag string
    apTag query parameter. Filter results by AP Tag
    Band string
    band query parameter. Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.
    Ssid int
    ssid query parameter. Filter results by SSID
    T0 string
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 180 days from today.
    T1 string
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 7 days after t0.
    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 7 days.
    Vlan int
    vlan query parameter. Filter results by VLAN
    Id string
    The provider-assigned unique ID for this managed resource.
    Item GetWirelessConnectionStatsItem
    Serial string
    serial path parameter.
    ApTag string
    apTag query parameter. Filter results by AP Tag
    Band string
    band query parameter. Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.
    Ssid int
    ssid query parameter. Filter results by SSID
    T0 string
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 180 days from today.
    T1 string
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 7 days after t0.
    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 7 days.
    Vlan int
    vlan query parameter. Filter results by VLAN
    id String
    The provider-assigned unique ID for this managed resource.
    item GetWirelessConnectionStatsItem
    serial String
    serial path parameter.
    apTag String
    apTag query parameter. Filter results by AP Tag
    band String
    band query parameter. Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.
    ssid Integer
    ssid query parameter. Filter results by SSID
    t0 String
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 180 days from today.
    t1 String
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 7 days after t0.
    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 7 days.
    vlan Integer
    vlan query parameter. Filter results by VLAN
    id string
    The provider-assigned unique ID for this managed resource.
    item GetWirelessConnectionStatsItem
    serial string
    serial path parameter.
    apTag string
    apTag query parameter. Filter results by AP Tag
    band string
    band query parameter. Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.
    ssid number
    ssid query parameter. Filter results by SSID
    t0 string
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 180 days from today.
    t1 string
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 7 days after t0.
    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 7 days.
    vlan number
    vlan query parameter. Filter results by VLAN
    id str
    The provider-assigned unique ID for this managed resource.
    item GetWirelessConnectionStatsItem
    serial str
    serial path parameter.
    ap_tag str
    apTag query parameter. Filter results by AP Tag
    band str
    band query parameter. Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.
    ssid int
    ssid query parameter. Filter results by SSID
    t0 str
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 180 days from today.
    t1 str
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 7 days after t0.
    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 7 days.
    vlan int
    vlan query parameter. Filter results by VLAN
    id String
    The provider-assigned unique ID for this managed resource.
    item Property Map
    serial String
    serial path parameter.
    apTag String
    apTag query parameter. Filter results by AP Tag
    band String
    band query parameter. Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.
    ssid Number
    ssid query parameter. Filter results by SSID
    t0 String
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 180 days from today.
    t1 String
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 7 days after t0.
    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 7 days.
    vlan Number
    vlan query parameter. Filter results by VLAN

    Supporting Types

    GetWirelessConnectionStatsItem

    ConnectionStats GetWirelessConnectionStatsItemConnectionStats
    The connection stats of the device
    Serial string
    The serial number for the device
    ConnectionStats GetWirelessConnectionStatsItemConnectionStats
    The connection stats of the device
    Serial string
    The serial number for the device
    connectionStats GetWirelessConnectionStatsItemConnectionStats
    The connection stats of the device
    serial String
    The serial number for the device
    connectionStats GetWirelessConnectionStatsItemConnectionStats
    The connection stats of the device
    serial string
    The serial number for the device
    connection_stats GetWirelessConnectionStatsItemConnectionStats
    The connection stats of the device
    serial str
    The serial number for the device
    connectionStats Property Map
    The connection stats of the device
    serial String
    The serial number for the device

    GetWirelessConnectionStatsItemConnectionStats

    Assoc int
    The number of failed association attempts
    Auth int
    The number of failed authentication attempts
    Dhcp int
    The number of failed DHCP attempts
    Dns int
    The number of failed DNS attempts
    Success int
    The number of successful connection attempts
    Assoc int
    The number of failed association attempts
    Auth int
    The number of failed authentication attempts
    Dhcp int
    The number of failed DHCP attempts
    Dns int
    The number of failed DNS attempts
    Success int
    The number of successful connection attempts
    assoc Integer
    The number of failed association attempts
    auth Integer
    The number of failed authentication attempts
    dhcp Integer
    The number of failed DHCP attempts
    dns Integer
    The number of failed DNS attempts
    success Integer
    The number of successful connection attempts
    assoc number
    The number of failed association attempts
    auth number
    The number of failed authentication attempts
    dhcp number
    The number of failed DHCP attempts
    dns number
    The number of failed DNS attempts
    success number
    The number of successful connection attempts
    assoc int
    The number of failed association attempts
    auth int
    The number of failed authentication attempts
    dhcp int
    The number of failed DHCP attempts
    dns int
    The number of failed DNS attempts
    success int
    The number of successful connection attempts
    assoc Number
    The number of failed association attempts
    auth Number
    The number of failed authentication attempts
    dhcp Number
    The number of failed DHCP attempts
    dns Number
    The number of failed DNS attempts
    success Number
    The number of successful connection attempts

    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