1. Packages
  2. Cisco Meraki
  3. API Docs
  4. networks
  5. getClientsOverview
Cisco Meraki v0.2.0 published on Friday, May 24, 2024 by Pulumi

meraki.networks.getClientsOverview

Explore with Pulumi AI

meraki logo
Cisco Meraki v0.2.0 published on Friday, May 24, 2024 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as meraki from "@pulumi/meraki";
    
    const example = meraki.networks.getClientsOverview({
        networkId: "string",
        resolution: 1,
        t0: "string",
        t1: "string",
        timespan: 1,
    });
    export const merakiNetworksClientsOverviewExample = example.then(example => example.item);
    
    import pulumi
    import pulumi_meraki as meraki
    
    example = meraki.networks.get_clients_overview(network_id="string",
        resolution=1,
        t0="string",
        t1="string",
        timespan=1)
    pulumi.export("merakiNetworksClientsOverviewExample", 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.GetClientsOverview(ctx, &networks.GetClientsOverviewArgs{
    			NetworkId:  "string",
    			Resolution: pulumi.IntRef(1),
    			T0:         pulumi.StringRef("string"),
    			T1:         pulumi.StringRef("string"),
    			Timespan:   pulumi.Float64Ref(1),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("merakiNetworksClientsOverviewExample", 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.GetClientsOverview.Invoke(new()
        {
            NetworkId = "string",
            Resolution = 1,
            T0 = "string",
            T1 = "string",
            Timespan = 1,
        });
    
        return new Dictionary<string, object?>
        {
            ["merakiNetworksClientsOverviewExample"] = example.Apply(getClientsOverviewResult => getClientsOverviewResult.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.GetClientsOverviewArgs;
    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.getClientsOverview(GetClientsOverviewArgs.builder()
                .networkId("string")
                .resolution(1)
                .t0("string")
                .t1("string")
                .timespan(1)
                .build());
    
            ctx.export("merakiNetworksClientsOverviewExample", example.applyValue(getClientsOverviewResult -> getClientsOverviewResult.item()));
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: meraki:networks:getClientsOverview
          Arguments:
            networkId: string
            resolution: 1
            t0: string
            t1: string
            timespan: 1
    outputs:
      merakiNetworksClientsOverviewExample: ${example.item}
    

    Using getClientsOverview

    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 getClientsOverview(args: GetClientsOverviewArgs, opts?: InvokeOptions): Promise<GetClientsOverviewResult>
    function getClientsOverviewOutput(args: GetClientsOverviewOutputArgs, opts?: InvokeOptions): Output<GetClientsOverviewResult>
    def get_clients_overview(network_id: Optional[str] = None,
                             resolution: Optional[int] = None,
                             t0: Optional[str] = None,
                             t1: Optional[str] = None,
                             timespan: Optional[float] = None,
                             opts: Optional[InvokeOptions] = None) -> GetClientsOverviewResult
    def get_clients_overview_output(network_id: Optional[pulumi.Input[str]] = None,
                             resolution: Optional[pulumi.Input[int]] = None,
                             t0: Optional[pulumi.Input[str]] = None,
                             t1: Optional[pulumi.Input[str]] = None,
                             timespan: Optional[pulumi.Input[float]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetClientsOverviewResult]
    func GetClientsOverview(ctx *Context, args *GetClientsOverviewArgs, opts ...InvokeOption) (*GetClientsOverviewResult, error)
    func GetClientsOverviewOutput(ctx *Context, args *GetClientsOverviewOutputArgs, opts ...InvokeOption) GetClientsOverviewResultOutput

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

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

    The following arguments are supported:

    NetworkId string
    networkId path parameter. Network ID
    Resolution int
    resolution query parameter. The time resolution in seconds for returned data. The valid resolutions are: 7200, 86400, 604800, 2592000. The default is 604800.
    T0 string
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
    T1 string
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 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 31 days. The default is 1 day.
    NetworkId string
    networkId path parameter. Network ID
    Resolution int
    resolution query parameter. The time resolution in seconds for returned data. The valid resolutions are: 7200, 86400, 604800, 2592000. The default is 604800.
    T0 string
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
    T1 string
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 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 31 days. The default is 1 day.
    networkId String
    networkId path parameter. Network ID
    resolution Integer
    resolution query parameter. The time resolution in seconds for returned data. The valid resolutions are: 7200, 86400, 604800, 2592000. The default is 604800.
    t0 String
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
    t1 String
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 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 31 days. The default is 1 day.
    networkId string
    networkId path parameter. Network ID
    resolution number
    resolution query parameter. The time resolution in seconds for returned data. The valid resolutions are: 7200, 86400, 604800, 2592000. The default is 604800.
    t0 string
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
    t1 string
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 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 31 days. The default is 1 day.
    network_id str
    networkId path parameter. Network ID
    resolution int
    resolution query parameter. The time resolution in seconds for returned data. The valid resolutions are: 7200, 86400, 604800, 2592000. The default is 604800.
    t0 str
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
    t1 str
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 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 31 days. The default is 1 day.
    networkId String
    networkId path parameter. Network ID
    resolution Number
    resolution query parameter. The time resolution in seconds for returned data. The valid resolutions are: 7200, 86400, 604800, 2592000. The default is 604800.
    t0 String
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
    t1 String
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 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 31 days. The default is 1 day.

    getClientsOverview Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Item GetClientsOverviewItem
    NetworkId string
    networkId path parameter. Network ID
    Resolution int
    resolution query parameter. The time resolution in seconds for returned data. The valid resolutions are: 7200, 86400, 604800, 2592000. The default is 604800.
    T0 string
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
    T1 string
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 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 31 days. The default is 1 day.
    Id string
    The provider-assigned unique ID for this managed resource.
    Item GetClientsOverviewItem
    NetworkId string
    networkId path parameter. Network ID
    Resolution int
    resolution query parameter. The time resolution in seconds for returned data. The valid resolutions are: 7200, 86400, 604800, 2592000. The default is 604800.
    T0 string
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
    T1 string
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 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 31 days. The default is 1 day.
    id String
    The provider-assigned unique ID for this managed resource.
    item GetClientsOverviewItem
    networkId String
    networkId path parameter. Network ID
    resolution Integer
    resolution query parameter. The time resolution in seconds for returned data. The valid resolutions are: 7200, 86400, 604800, 2592000. The default is 604800.
    t0 String
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
    t1 String
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 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 31 days. The default is 1 day.
    id string
    The provider-assigned unique ID for this managed resource.
    item GetClientsOverviewItem
    networkId string
    networkId path parameter. Network ID
    resolution number
    resolution query parameter. The time resolution in seconds for returned data. The valid resolutions are: 7200, 86400, 604800, 2592000. The default is 604800.
    t0 string
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
    t1 string
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 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 31 days. The default is 1 day.
    id str
    The provider-assigned unique ID for this managed resource.
    item GetClientsOverviewItem
    network_id str
    networkId path parameter. Network ID
    resolution int
    resolution query parameter. The time resolution in seconds for returned data. The valid resolutions are: 7200, 86400, 604800, 2592000. The default is 604800.
    t0 str
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
    t1 str
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 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 31 days. The default is 1 day.
    id String
    The provider-assigned unique ID for this managed resource.
    item Property Map
    networkId String
    networkId path parameter. Network ID
    resolution Number
    resolution query parameter. The time resolution in seconds for returned data. The valid resolutions are: 7200, 86400, 604800, 2592000. The default is 604800.
    t0 String
    t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
    t1 String
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 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 31 days. The default is 1 day.

    Supporting Types

    GetClientsOverviewItem

    Counts GetClientsOverviewItemCounts
    The number of clients on a network over a given time range
    Usages GetClientsOverviewItemUsages
    The average usage of the clients on a network over a given time range
    Counts GetClientsOverviewItemCounts
    The number of clients on a network over a given time range
    Usages GetClientsOverviewItemUsages
    The average usage of the clients on a network over a given time range
    counts GetClientsOverviewItemCounts
    The number of clients on a network over a given time range
    usages GetClientsOverviewItemUsages
    The average usage of the clients on a network over a given time range
    counts GetClientsOverviewItemCounts
    The number of clients on a network over a given time range
    usages GetClientsOverviewItemUsages
    The average usage of the clients on a network over a given time range
    counts GetClientsOverviewItemCounts
    The number of clients on a network over a given time range
    usages GetClientsOverviewItemUsages
    The average usage of the clients on a network over a given time range
    counts Property Map
    The number of clients on a network over a given time range
    usages Property Map
    The average usage of the clients on a network over a given time range

    GetClientsOverviewItemCounts

    Total int
    The total number of clients on a network
    WithHeavyUsage int
    The total number of clients with heavy usage on a network
    Total int
    The total number of clients on a network
    WithHeavyUsage int
    The total number of clients with heavy usage on a network
    total Integer
    The total number of clients on a network
    withHeavyUsage Integer
    The total number of clients with heavy usage on a network
    total number
    The total number of clients on a network
    withHeavyUsage number
    The total number of clients with heavy usage on a network
    total int
    The total number of clients on a network
    with_heavy_usage int
    The total number of clients with heavy usage on a network
    total Number
    The total number of clients on a network
    withHeavyUsage Number
    The total number of clients with heavy usage on a network

    GetClientsOverviewItemUsages

    Average int
    The average usage of all clients on a network
    WithHeavyUsageAverage int
    The average usage of all clients with heavy usage on a network
    Average int
    The average usage of all clients on a network
    WithHeavyUsageAverage int
    The average usage of all clients with heavy usage on a network
    average Integer
    The average usage of all clients on a network
    withHeavyUsageAverage Integer
    The average usage of all clients with heavy usage on a network
    average number
    The average usage of all clients on a network
    withHeavyUsageAverage number
    The average usage of all clients with heavy usage on a network
    average int
    The average usage of all clients on a network
    with_heavy_usage_average int
    The average usage of all clients with heavy usage on a network
    average Number
    The average usage of all clients on a network
    withHeavyUsageAverage Number
    The average usage of all clients with heavy usage on a network

    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.0 published on Friday, May 24, 2024 by Pulumi