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

meraki.networks.getWirelessClientsConnectionStats

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.networks.getWirelessClientsConnectionStats({
        apTag: "string",
        band: "string",
        clientId: "string",
        networkId: "string",
        ssid: 1,
        t0: "string",
        t1: "string",
        timespan: 1,
        vlan: 1,
    });
    export const merakiNetworksWirelessClientsConnectionStatsExample = example.then(example => example.item);
    
    import pulumi
    import pulumi_meraki as meraki
    
    example = meraki.networks.get_wireless_clients_connection_stats(ap_tag="string",
        band="string",
        client_id="string",
        network_id="string",
        ssid=1,
        t0="string",
        t1="string",
        timespan=1,
        vlan=1)
    pulumi.export("merakiNetworksWirelessClientsConnectionStatsExample", example.item)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-meraki/sdk/go/meraki/networks"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := networks.GetWirelessClientsConnectionStats(ctx, &networks.GetWirelessClientsConnectionStatsArgs{
    			ApTag:     pulumi.StringRef("string"),
    			Band:      pulumi.StringRef("string"),
    			ClientId:  "string",
    			NetworkId: "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("merakiNetworksWirelessClientsConnectionStatsExample", example.Item)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Meraki = Pulumi.Meraki;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Meraki.Networks.GetWirelessClientsConnectionStats.Invoke(new()
        {
            ApTag = "string",
            Band = "string",
            ClientId = "string",
            NetworkId = "string",
            Ssid = 1,
            T0 = "string",
            T1 = "string",
            Timespan = 1,
            Vlan = 1,
        });
    
        return new Dictionary<string, object?>
        {
            ["merakiNetworksWirelessClientsConnectionStatsExample"] = example.Apply(getWirelessClientsConnectionStatsResult => getWirelessClientsConnectionStatsResult.Item),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.meraki.networks.NetworksFunctions;
    import com.pulumi.meraki.networks.inputs.GetWirelessClientsConnectionStatsArgs;
    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 = NetworksFunctions.getWirelessClientsConnectionStats(GetWirelessClientsConnectionStatsArgs.builder()
                .apTag("string")
                .band("string")
                .clientId("string")
                .networkId("string")
                .ssid(1)
                .t0("string")
                .t1("string")
                .timespan(1)
                .vlan(1)
                .build());
    
            ctx.export("merakiNetworksWirelessClientsConnectionStatsExample", example.applyValue(getWirelessClientsConnectionStatsResult -> getWirelessClientsConnectionStatsResult.item()));
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: meraki:networks:getWirelessClientsConnectionStats
          Arguments:
            apTag: string
            band: string
            clientId: string
            networkId: string
            ssid: 1
            t0: string
            t1: string
            timespan: 1
            vlan: 1
    outputs:
      merakiNetworksWirelessClientsConnectionStatsExample: ${example.item}
    

    Using getWirelessClientsConnectionStats

    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 getWirelessClientsConnectionStats(args: GetWirelessClientsConnectionStatsArgs, opts?: InvokeOptions): Promise<GetWirelessClientsConnectionStatsResult>
    function getWirelessClientsConnectionStatsOutput(args: GetWirelessClientsConnectionStatsOutputArgs, opts?: InvokeOptions): Output<GetWirelessClientsConnectionStatsResult>
    def get_wireless_clients_connection_stats(ap_tag: Optional[str] = None,
                                              band: Optional[str] = None,
                                              client_id: Optional[str] = None,
                                              network_id: 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) -> GetWirelessClientsConnectionStatsResult
    def get_wireless_clients_connection_stats_output(ap_tag: Optional[pulumi.Input[str]] = None,
                                              band: Optional[pulumi.Input[str]] = None,
                                              client_id: Optional[pulumi.Input[str]] = None,
                                              network_id: 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[GetWirelessClientsConnectionStatsResult]
    func GetWirelessClientsConnectionStats(ctx *Context, args *GetWirelessClientsConnectionStatsArgs, opts ...InvokeOption) (*GetWirelessClientsConnectionStatsResult, error)
    func GetWirelessClientsConnectionStatsOutput(ctx *Context, args *GetWirelessClientsConnectionStatsOutputArgs, opts ...InvokeOption) GetWirelessClientsConnectionStatsResultOutput

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

    public static class GetWirelessClientsConnectionStats 
    {
        public static Task<GetWirelessClientsConnectionStatsResult> InvokeAsync(GetWirelessClientsConnectionStatsArgs args, InvokeOptions? opts = null)
        public static Output<GetWirelessClientsConnectionStatsResult> Invoke(GetWirelessClientsConnectionStatsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetWirelessClientsConnectionStatsResult> getWirelessClientsConnectionStats(GetWirelessClientsConnectionStatsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: meraki:networks/getWirelessClientsConnectionStats:getWirelessClientsConnectionStats
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ClientId string
    clientId path parameter. Client ID
    NetworkId string
    networkId path parameter. Network ID
    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
    ClientId string
    clientId path parameter. Client ID
    NetworkId string
    networkId path parameter. Network ID
    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
    clientId String
    clientId path parameter. Client ID
    networkId String
    networkId path parameter. Network ID
    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
    clientId string
    clientId path parameter. Client ID
    networkId string
    networkId path parameter. Network ID
    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
    client_id str
    clientId path parameter. Client ID
    network_id str
    networkId path parameter. Network ID
    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
    clientId String
    clientId path parameter. Client ID
    networkId String
    networkId path parameter. Network ID
    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

    getWirelessClientsConnectionStats Result

    The following output properties are available:

    ClientId string
    clientId path parameter. Client ID
    Id string
    The provider-assigned unique ID for this managed resource.
    Item GetWirelessClientsConnectionStatsItem
    NetworkId string
    networkId path parameter. Network ID
    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
    ClientId string
    clientId path parameter. Client ID
    Id string
    The provider-assigned unique ID for this managed resource.
    Item GetWirelessClientsConnectionStatsItem
    NetworkId string
    networkId path parameter. Network ID
    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
    clientId String
    clientId path parameter. Client ID
    id String
    The provider-assigned unique ID for this managed resource.
    item GetWirelessClientsConnectionStatsItem
    networkId String
    networkId path parameter. Network ID
    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
    clientId string
    clientId path parameter. Client ID
    id string
    The provider-assigned unique ID for this managed resource.
    item GetWirelessClientsConnectionStatsItem
    networkId string
    networkId path parameter. Network ID
    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
    client_id str
    clientId path parameter. Client ID
    id str
    The provider-assigned unique ID for this managed resource.
    item GetWirelessClientsConnectionStatsItem
    network_id str
    networkId path parameter. Network ID
    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
    clientId String
    clientId path parameter. Client ID
    id String
    The provider-assigned unique ID for this managed resource.
    item Property Map
    networkId String
    networkId path parameter. Network ID
    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

    GetWirelessClientsConnectionStatsItem

    GetWirelessClientsConnectionStatsItemConnectionStats

    Assoc int
    Auth int
    Dhcp int
    Dns int
    Success int
    Assoc int
    Auth int
    Dhcp int
    Dns int
    Success int
    assoc Integer
    auth Integer
    dhcp Integer
    dns Integer
    success Integer
    assoc number
    auth number
    dhcp number
    dns number
    success number
    assoc int
    auth int
    dhcp int
    dns int
    success int
    assoc Number
    auth Number
    dhcp Number
    dns Number
    success Number

    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