Docs Packages
  1. Packages
  2. Cisco Meraki
  3. API Docs
  4. organizations
  5. getSummaryTopSsidsByUsage
Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi
pulumi/pulumi-meraki

meraki.organizations.getSummaryTopSsidsByUsage

Explore with Pulumi AI

meraki logo
Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi
pulumi/pulumi-meraki

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as meraki from "@pulumi/meraki";

const example = meraki.organizations.getSummaryTopSsidsByUsage({
    organizationId: "string",
    t0: "string",
    t1: "string",
    timespan: 1,
});
export const merakiOrganizationsSummaryTopSsidsByUsageExample = example.then(example => example.items);

    import pulumi
import pulumi_meraki as meraki

example = meraki.organizations.get_summary_top_ssids_by_usage(organization_id="string",
    t0="string",
    t1="string",
    timespan=1)
pulumi.export("merakiOrganizationsSummaryTopSsidsByUsageExample", 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.GetSummaryTopSsidsByUsage(ctx, &organizations.GetSummaryTopSsidsByUsageArgs{
			OrganizationId: "string",
			T0:             pulumi.StringRef("string"),
			T1:             pulumi.StringRef("string"),
			Timespan:       pulumi.Float64Ref(1),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("merakiOrganizationsSummaryTopSsidsByUsageExample", 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.GetSummaryTopSsidsByUsage.Invoke(new()
    {
        OrganizationId = "string",
        T0 = "string",
        T1 = "string",
        Timespan = 1,
    });

    return new Dictionary<string, object?>
    {
        ["merakiOrganizationsSummaryTopSsidsByUsageExample"] = example.Apply(getSummaryTopSsidsByUsageResult => getSummaryTopSsidsByUsageResult.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.GetSummaryTopSsidsByUsageArgs;
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.getSummaryTopSsidsByUsage(GetSummaryTopSsidsByUsageArgs.builder()
            .organizationId("string")
            .t0("string")
            .t1("string")
            .timespan(1)
            .build());

        ctx.export("merakiOrganizationsSummaryTopSsidsByUsageExample", example.applyValue(getSummaryTopSsidsByUsageResult -> getSummaryTopSsidsByUsageResult.items()));
    }
}

    variables:
  example:
    fn::invoke:
      Function: meraki:organizations:getSummaryTopSsidsByUsage
      Arguments:
        organizationId: string
        t0: string
        t1: string
        timespan: 1
outputs:
  merakiOrganizationsSummaryTopSsidsByUsageExample: ${example.items}

    Using getSummaryTopSsidsByUsage

    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 getSummaryTopSsidsByUsage(args: GetSummaryTopSsidsByUsageArgs, opts?: InvokeOptions): Promise<GetSummaryTopSsidsByUsageResult>
function getSummaryTopSsidsByUsageOutput(args: GetSummaryTopSsidsByUsageOutputArgs, opts?: InvokeOptions): Output<GetSummaryTopSsidsByUsageResult>
    def get_summary_top_ssids_by_usage(organization_id: Optional[str] = None,
                                   t0: Optional[str] = None,
                                   t1: Optional[str] = None,
                                   timespan: Optional[float] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetSummaryTopSsidsByUsageResult
def get_summary_top_ssids_by_usage_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[GetSummaryTopSsidsByUsageResult]
    func GetSummaryTopSsidsByUsage(ctx *Context, args *GetSummaryTopSsidsByUsageArgs, opts ...InvokeOption) (*GetSummaryTopSsidsByUsageResult, error)
func GetSummaryTopSsidsByUsageOutput(ctx *Context, args *GetSummaryTopSsidsByUsageOutputArgs, opts ...InvokeOption) GetSummaryTopSsidsByUsageResultOutput

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

    public static class GetSummaryTopSsidsByUsage 
{
    public static Task<GetSummaryTopSsidsByUsageResult> InvokeAsync(GetSummaryTopSsidsByUsageArgs args, InvokeOptions? opts = null)
    public static Output<GetSummaryTopSsidsByUsageResult> Invoke(GetSummaryTopSsidsByUsageInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSummaryTopSsidsByUsageResult> getSummaryTopSsidsByUsage(GetSummaryTopSsidsByUsageArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: meraki:organizations/getSummaryTopSsidsByUsage:getSummaryTopSsidsByUsage
  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 greater than or equal to 8 hours 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 greater than or equal to 8 hours 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 greater than or equal to 8 hours 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 greater than or equal to 8 hours 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 greater than or equal to 8 hours 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 greater than or equal to 8 hours and be less than or equal to 31 days. The default is 1 day.

    getSummaryTopSsidsByUsage Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Items List<GetSummaryTopSsidsByUsageItem>
    Array of ResponseOrganizationsGetOrganizationSummaryTopSsidsByUsage
    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 greater than or equal to 8 hours 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.
    Items []GetSummaryTopSsidsByUsageItem
    Array of ResponseOrganizationsGetOrganizationSummaryTopSsidsByUsage
    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 greater than or equal to 8 hours 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.
    items List<GetSummaryTopSsidsByUsageItem>
    Array of ResponseOrganizationsGetOrganizationSummaryTopSsidsByUsage
    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 greater than or equal to 8 hours 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.
    items GetSummaryTopSsidsByUsageItem[]
    Array of ResponseOrganizationsGetOrganizationSummaryTopSsidsByUsage
    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 greater than or equal to 8 hours 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.
    items Sequence[GetSummaryTopSsidsByUsageItem]
    Array of ResponseOrganizationsGetOrganizationSummaryTopSsidsByUsage
    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 greater than or equal to 8 hours 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.
    items List<Property Map>
    Array of ResponseOrganizationsGetOrganizationSummaryTopSsidsByUsage
    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 greater than or equal to 8 hours and be less than or equal to 31 days. The default is 1 day.

    Supporting Types

    GetSummaryTopSsidsByUsageItem

    Clients GetSummaryTopSsidsByUsageItemClients
    Clients info of the SSID
    Name string
    Name of the SSID
    Usage GetSummaryTopSsidsByUsageItemUsage
    Date usage of the SSID, in megabytes
    Clients GetSummaryTopSsidsByUsageItemClients
    Clients info of the SSID
    Name string
    Name of the SSID
    Usage GetSummaryTopSsidsByUsageItemUsage
    Date usage of the SSID, in megabytes
    clients GetSummaryTopSsidsByUsageItemClients
    Clients info of the SSID
    name String
    Name of the SSID
    usage GetSummaryTopSsidsByUsageItemUsage
    Date usage of the SSID, in megabytes
    clients GetSummaryTopSsidsByUsageItemClients
    Clients info of the SSID
    name string
    Name of the SSID
    usage GetSummaryTopSsidsByUsageItemUsage
    Date usage of the SSID, in megabytes
    clients GetSummaryTopSsidsByUsageItemClients
    Clients info of the SSID
    name str
    Name of the SSID
    usage GetSummaryTopSsidsByUsageItemUsage
    Date usage of the SSID, in megabytes
    clients Property Map
    Clients info of the SSID
    name String
    Name of the SSID
    usage Property Map
    Date usage of the SSID, in megabytes

    GetSummaryTopSsidsByUsageItemClients

    counts Property Map
    Counts of the clients

    GetSummaryTopSsidsByUsageItemClientsCounts

    Total int
    Total counts of the clients
    Total int
    Total counts of the clients
    total Integer
    Total counts of the clients
    total number
    Total counts of the clients
    total int
    Total counts of the clients
    total Number
    Total counts of the clients

    GetSummaryTopSsidsByUsageItemUsage

    Downstream double
    Downstream usage of the SSID
    Percentage double
    Percentage usage of the SSID
    Total double
    Total usage of the SSID
    Upstream double
    Upstream usage of the SSID
    Downstream float64
    Downstream usage of the SSID
    Percentage float64
    Percentage usage of the SSID
    Total float64
    Total usage of the SSID
    Upstream float64
    Upstream usage of the SSID
    downstream Double
    Downstream usage of the SSID
    percentage Double
    Percentage usage of the SSID
    total Double
    Total usage of the SSID
    upstream Double
    Upstream usage of the SSID
    downstream number
    Downstream usage of the SSID
    percentage number
    Percentage usage of the SSID
    total number
    Total usage of the SSID
    upstream number
    Upstream usage of the SSID
    downstream float
    Downstream usage of the SSID
    percentage float
    Percentage usage of the SSID
    total float
    Total usage of the SSID
    upstream float
    Upstream usage of the SSID
    downstream Number
    Downstream usage of the SSID
    percentage Number
    Percentage usage of the SSID
    total Number
    Total usage of the SSID
    upstream Number
    Upstream usage of the SSID

    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
    pulumi/pulumi-meraki