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

meraki.organizations.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.organizations.getClientsOverview({
        organizationId: "string",
        t0: "string",
        t1: "string",
        timespan: 1,
    });
    export const merakiOrganizationsClientsOverviewExample = example.then(example => example.item);
    
    import pulumi
    import pulumi_meraki as meraki
    
    example = meraki.organizations.get_clients_overview(organization_id="string",
        t0="string",
        t1="string",
        timespan=1)
    pulumi.export("merakiOrganizationsClientsOverviewExample", example.item)
    
    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.GetClientsOverview(ctx, &organizations.GetClientsOverviewArgs{
    			OrganizationId: "string",
    			T0:             pulumi.StringRef("string"),
    			T1:             pulumi.StringRef("string"),
    			Timespan:       pulumi.Float64Ref(1),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("merakiOrganizationsClientsOverviewExample", example.Item)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Meraki = Pulumi.Meraki;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Meraki.Organizations.GetClientsOverview.Invoke(new()
        {
            OrganizationId = "string",
            T0 = "string",
            T1 = "string",
            Timespan = 1,
        });
    
        return new Dictionary<string, object?>
        {
            ["merakiOrganizationsClientsOverviewExample"] = 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.organizations.OrganizationsFunctions;
    import com.pulumi.meraki.organizations.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 = OrganizationsFunctions.getClientsOverview(GetClientsOverviewArgs.builder()
                .organizationId("string")
                .t0("string")
                .t1("string")
                .timespan(1)
                .build());
    
            ctx.export("merakiOrganizationsClientsOverviewExample", example.applyValue(getClientsOverviewResult -> getClientsOverviewResult.item()));
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: meraki:organizations:getClientsOverview
          Arguments:
            organizationId: string
            t0: string
            t1: string
            timespan: 1
    outputs:
      merakiOrganizationsClientsOverviewExample: ${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(organization_id: Optional[str] = None,
                             t0: Optional[str] = None,
                             t1: Optional[str] = None,
                             timespan: Optional[float] = None,
                             opts: Optional[InvokeOptions] = None) -> GetClientsOverviewResult
    def get_clients_overview_output(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,
                             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:organizations/getClientsOverview:getClientsOverview
      arguments:
        # arguments dictionary

    The following arguments are supported:

    OrganizationId string
    organizationId path parameter. Organization ID
    T0 string
    t0 query parameter. The beginning of the timespan for the data.
    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.
    OrganizationId string
    organizationId path parameter. Organization ID
    T0 string
    t0 query parameter. The beginning of the timespan for the data.
    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.
    organizationId String
    organizationId path parameter. Organization ID
    t0 String
    t0 query parameter. The beginning of the timespan for the data.
    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.
    organizationId string
    organizationId path parameter. Organization ID
    t0 string
    t0 query parameter. The beginning of the timespan for the data.
    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.
    organization_id str
    organizationId path parameter. Organization ID
    t0 str
    t0 query parameter. The beginning of the timespan for the data.
    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.
    organizationId String
    organizationId path parameter. Organization ID
    t0 String
    t0 query parameter. The beginning of the timespan for the data.
    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
    OrganizationId string
    organizationId path parameter. Organization ID
    T0 string
    t0 query parameter. The beginning of the timespan for the data.
    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
    OrganizationId string
    organizationId path parameter. Organization ID
    T0 string
    t0 query parameter. The beginning of the timespan for the data.
    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
    organizationId String
    organizationId path parameter. Organization ID
    t0 String
    t0 query parameter. The beginning of the timespan for the data.
    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
    organizationId string
    organizationId path parameter. Organization ID
    t0 string
    t0 query parameter. The beginning of the timespan for the data.
    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
    organization_id str
    organizationId path parameter. Organization ID
    t0 str
    t0 query parameter. The beginning of the timespan for the data.
    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
    organizationId String
    organizationId path parameter. Organization ID
    t0 String
    t0 query parameter. The beginning of the timespan for the data.
    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
    Client count information
    Usage GetClientsOverviewItemUsage
    Usage information of all clients across organization
    Counts GetClientsOverviewItemCounts
    Client count information
    Usage GetClientsOverviewItemUsage
    Usage information of all clients across organization
    counts GetClientsOverviewItemCounts
    Client count information
    usage GetClientsOverviewItemUsage
    Usage information of all clients across organization
    counts GetClientsOverviewItemCounts
    Client count information
    usage GetClientsOverviewItemUsage
    Usage information of all clients across organization
    counts GetClientsOverviewItemCounts
    Client count information
    usage GetClientsOverviewItemUsage
    Usage information of all clients across organization
    counts Property Map
    Client count information
    usage Property Map
    Usage information of all clients across organization

    GetClientsOverviewItemCounts

    Total int
    Total number of clients with data usage in organization
    Total int
    Total number of clients with data usage in organization
    total Integer
    Total number of clients with data usage in organization
    total number
    Total number of clients with data usage in organization
    total int
    Total number of clients with data usage in organization
    total Number
    Total number of clients with data usage in organization

    GetClientsOverviewItemUsage

    Average double
    Average data usage (in kb) of each client in organization
    Overall GetClientsOverviewItemUsageOverall
    Overall data usage of all clients across organization
    Average float64
    Average data usage (in kb) of each client in organization
    Overall GetClientsOverviewItemUsageOverall
    Overall data usage of all clients across organization
    average Double
    Average data usage (in kb) of each client in organization
    overall GetClientsOverviewItemUsageOverall
    Overall data usage of all clients across organization
    average number
    Average data usage (in kb) of each client in organization
    overall GetClientsOverviewItemUsageOverall
    Overall data usage of all clients across organization
    average float
    Average data usage (in kb) of each client in organization
    overall GetClientsOverviewItemUsageOverall
    Overall data usage of all clients across organization
    average Number
    Average data usage (in kb) of each client in organization
    overall Property Map
    Overall data usage of all clients across organization

    GetClientsOverviewItemUsageOverall

    Downstream double
    Downstream data usage (in kb) of all clients across organization
    Total double
    Total data usage (in kb) of all clients across organization
    Upstream double
    Upstream data usage (in kb) of all clients across organization
    Downstream float64
    Downstream data usage (in kb) of all clients across organization
    Total float64
    Total data usage (in kb) of all clients across organization
    Upstream float64
    Upstream data usage (in kb) of all clients across organization
    downstream Double
    Downstream data usage (in kb) of all clients across organization
    total Double
    Total data usage (in kb) of all clients across organization
    upstream Double
    Upstream data usage (in kb) of all clients across organization
    downstream number
    Downstream data usage (in kb) of all clients across organization
    total number
    Total data usage (in kb) of all clients across organization
    upstream number
    Upstream data usage (in kb) of all clients across organization
    downstream float
    Downstream data usage (in kb) of all clients across organization
    total float
    Total data usage (in kb) of all clients across organization
    upstream float
    Upstream data usage (in kb) of all clients across organization
    downstream Number
    Downstream data usage (in kb) of all clients across organization
    total Number
    Total data usage (in kb) of all clients across organization
    upstream Number
    Upstream data usage (in kb) of all clients across organization

    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