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

meraki.organizations.getSummaryTopNetworksByStatus

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.organizations.getSummaryTopNetworksByStatus({
        endingBefore: "string",
        organizationId: "string",
        perPage: 1,
        startingAfter: "string",
    });
    export const merakiOrganizationsSummaryTopNetworksByStatusExample = example.then(example => example.items);
    
    import pulumi
    import pulumi_meraki as meraki
    
    example = meraki.organizations.get_summary_top_networks_by_status(ending_before="string",
        organization_id="string",
        per_page=1,
        starting_after="string")
    pulumi.export("merakiOrganizationsSummaryTopNetworksByStatusExample", 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.GetSummaryTopNetworksByStatus(ctx, &organizations.GetSummaryTopNetworksByStatusArgs{
    			EndingBefore:   pulumi.StringRef("string"),
    			OrganizationId: "string",
    			PerPage:        pulumi.IntRef(1),
    			StartingAfter:  pulumi.StringRef("string"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("merakiOrganizationsSummaryTopNetworksByStatusExample", 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.GetSummaryTopNetworksByStatus.Invoke(new()
        {
            EndingBefore = "string",
            OrganizationId = "string",
            PerPage = 1,
            StartingAfter = "string",
        });
    
        return new Dictionary<string, object?>
        {
            ["merakiOrganizationsSummaryTopNetworksByStatusExample"] = example.Apply(getSummaryTopNetworksByStatusResult => getSummaryTopNetworksByStatusResult.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.GetSummaryTopNetworksByStatusArgs;
    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.getSummaryTopNetworksByStatus(GetSummaryTopNetworksByStatusArgs.builder()
                .endingBefore("string")
                .organizationId("string")
                .perPage(1)
                .startingAfter("string")
                .build());
    
            ctx.export("merakiOrganizationsSummaryTopNetworksByStatusExample", example.applyValue(getSummaryTopNetworksByStatusResult -> getSummaryTopNetworksByStatusResult.items()));
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: meraki:organizations:getSummaryTopNetworksByStatus
          Arguments:
            endingBefore: string
            organizationId: string
            perPage: 1
            startingAfter: string
    outputs:
      merakiOrganizationsSummaryTopNetworksByStatusExample: ${example.items}
    

    Using getSummaryTopNetworksByStatus

    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 getSummaryTopNetworksByStatus(args: GetSummaryTopNetworksByStatusArgs, opts?: InvokeOptions): Promise<GetSummaryTopNetworksByStatusResult>
    function getSummaryTopNetworksByStatusOutput(args: GetSummaryTopNetworksByStatusOutputArgs, opts?: InvokeOptions): Output<GetSummaryTopNetworksByStatusResult>
    def get_summary_top_networks_by_status(ending_before: Optional[str] = None,
                                           organization_id: Optional[str] = None,
                                           per_page: Optional[int] = None,
                                           starting_after: Optional[str] = None,
                                           opts: Optional[InvokeOptions] = None) -> GetSummaryTopNetworksByStatusResult
    def get_summary_top_networks_by_status_output(ending_before: Optional[pulumi.Input[str]] = None,
                                           organization_id: Optional[pulumi.Input[str]] = None,
                                           per_page: Optional[pulumi.Input[int]] = None,
                                           starting_after: Optional[pulumi.Input[str]] = None,
                                           opts: Optional[InvokeOptions] = None) -> Output[GetSummaryTopNetworksByStatusResult]
    func GetSummaryTopNetworksByStatus(ctx *Context, args *GetSummaryTopNetworksByStatusArgs, opts ...InvokeOption) (*GetSummaryTopNetworksByStatusResult, error)
    func GetSummaryTopNetworksByStatusOutput(ctx *Context, args *GetSummaryTopNetworksByStatusOutputArgs, opts ...InvokeOption) GetSummaryTopNetworksByStatusResultOutput

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

    public static class GetSummaryTopNetworksByStatus 
    {
        public static Task<GetSummaryTopNetworksByStatusResult> InvokeAsync(GetSummaryTopNetworksByStatusArgs args, InvokeOptions? opts = null)
        public static Output<GetSummaryTopNetworksByStatusResult> Invoke(GetSummaryTopNetworksByStatusInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSummaryTopNetworksByStatusResult> getSummaryTopNetworksByStatus(GetSummaryTopNetworksByStatusArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: meraki:organizations/getSummaryTopNetworksByStatus:getSummaryTopNetworksByStatus
      arguments:
        # arguments dictionary

    The following arguments are supported:

    OrganizationId string
    organizationId path parameter. Organization ID
    EndingBefore string
    endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    PerPage int
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 5000.
    StartingAfter string
    startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    OrganizationId string
    organizationId path parameter. Organization ID
    EndingBefore string
    endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    PerPage int
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 5000.
    StartingAfter string
    startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    organizationId String
    organizationId path parameter. Organization ID
    endingBefore String
    endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    perPage Integer
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 5000.
    startingAfter String
    startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    organizationId string
    organizationId path parameter. Organization ID
    endingBefore string
    endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    perPage number
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 5000.
    startingAfter string
    startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    organization_id str
    organizationId path parameter. Organization ID
    ending_before str
    endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    per_page int
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 5000.
    starting_after str
    startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    organizationId String
    organizationId path parameter. Organization ID
    endingBefore String
    endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    perPage Number
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 5000.
    startingAfter String
    startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

    getSummaryTopNetworksByStatus Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Items List<GetSummaryTopNetworksByStatusItem>
    Array of ResponseOrganizationsGetOrganizationSummaryTopNetworksByStatus
    OrganizationId string
    organizationId path parameter. Organization ID
    EndingBefore string
    endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    PerPage int
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 5000.
    StartingAfter string
    startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    Id string
    The provider-assigned unique ID for this managed resource.
    Items []GetSummaryTopNetworksByStatusItem
    Array of ResponseOrganizationsGetOrganizationSummaryTopNetworksByStatus
    OrganizationId string
    organizationId path parameter. Organization ID
    EndingBefore string
    endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    PerPage int
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 5000.
    StartingAfter string
    startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    id String
    The provider-assigned unique ID for this managed resource.
    items List<GetSummaryTopNetworksByStatusItem>
    Array of ResponseOrganizationsGetOrganizationSummaryTopNetworksByStatus
    organizationId String
    organizationId path parameter. Organization ID
    endingBefore String
    endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    perPage Integer
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 5000.
    startingAfter String
    startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    id string
    The provider-assigned unique ID for this managed resource.
    items GetSummaryTopNetworksByStatusItem[]
    Array of ResponseOrganizationsGetOrganizationSummaryTopNetworksByStatus
    organizationId string
    organizationId path parameter. Organization ID
    endingBefore string
    endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    perPage number
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 5000.
    startingAfter string
    startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    id str
    The provider-assigned unique ID for this managed resource.
    items Sequence[GetSummaryTopNetworksByStatusItem]
    Array of ResponseOrganizationsGetOrganizationSummaryTopNetworksByStatus
    organization_id str
    organizationId path parameter. Organization ID
    ending_before str
    endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    per_page int
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 5000.
    starting_after str
    startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    id String
    The provider-assigned unique ID for this managed resource.
    items List<Property Map>
    Array of ResponseOrganizationsGetOrganizationSummaryTopNetworksByStatus
    organizationId String
    organizationId path parameter. Organization ID
    endingBefore String
    endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    perPage Number
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 5000.
    startingAfter String
    startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

    Supporting Types

    GetSummaryTopNetworksByStatusItem

    Clients GetSummaryTopNetworksByStatusItemClients
    Network clients data
    Devices GetSummaryTopNetworksByStatusItemDevices
    Network device information
    Name string
    Network name
    NetworkId string
    Network identifier
    ProductTypes List<string>
    Product types in network
    Statuses GetSummaryTopNetworksByStatusItemStatuses
    Network device statuses
    Tags List<string>
    Network tags
    Url string
    Network clients list URL
    Clients GetSummaryTopNetworksByStatusItemClients
    Network clients data
    Devices GetSummaryTopNetworksByStatusItemDevices
    Network device information
    Name string
    Network name
    NetworkId string
    Network identifier
    ProductTypes []string
    Product types in network
    Statuses GetSummaryTopNetworksByStatusItemStatuses
    Network device statuses
    Tags []string
    Network tags
    Url string
    Network clients list URL
    clients GetSummaryTopNetworksByStatusItemClients
    Network clients data
    devices GetSummaryTopNetworksByStatusItemDevices
    Network device information
    name String
    Network name
    networkId String
    Network identifier
    productTypes List<String>
    Product types in network
    statuses GetSummaryTopNetworksByStatusItemStatuses
    Network device statuses
    tags List<String>
    Network tags
    url String
    Network clients list URL
    clients GetSummaryTopNetworksByStatusItemClients
    Network clients data
    devices GetSummaryTopNetworksByStatusItemDevices
    Network device information
    name string
    Network name
    networkId string
    Network identifier
    productTypes string[]
    Product types in network
    statuses GetSummaryTopNetworksByStatusItemStatuses
    Network device statuses
    tags string[]
    Network tags
    url string
    Network clients list URL
    clients GetSummaryTopNetworksByStatusItemClients
    Network clients data
    devices GetSummaryTopNetworksByStatusItemDevices
    Network device information
    name str
    Network name
    network_id str
    Network identifier
    product_types Sequence[str]
    Product types in network
    statuses GetSummaryTopNetworksByStatusItemStatuses
    Network device statuses
    tags Sequence[str]
    Network tags
    url str
    Network clients list URL
    clients Property Map
    Network clients data
    devices Property Map
    Network device information
    name String
    Network name
    networkId String
    Network identifier
    productTypes List<String>
    Product types in network
    statuses Property Map
    Network device statuses
    tags List<String>
    Network tags
    url String
    Network clients list URL

    GetSummaryTopNetworksByStatusItemClients

    counts Property Map
    Network client counts
    usage Property Map
    Network client usage data

    GetSummaryTopNetworksByStatusItemClientsCounts

    Total int
    Total count of clients in network
    Total int
    Total count of clients in network
    total Integer
    Total count of clients in network
    total number
    Total count of clients in network
    total int
    Total count of clients in network
    total Number
    Total count of clients in network

    GetSummaryTopNetworksByStatusItemClientsUsage

    Downstream double
    Total downstream usage in network, in KB
    Upstream double
    Total upstream usage in network, in KB
    Downstream float64
    Total downstream usage in network, in KB
    Upstream float64
    Total upstream usage in network, in KB
    downstream Double
    Total downstream usage in network, in KB
    upstream Double
    Total upstream usage in network, in KB
    downstream number
    Total downstream usage in network, in KB
    upstream number
    Total upstream usage in network, in KB
    downstream float
    Total downstream usage in network, in KB
    upstream float
    Total upstream usage in network, in KB
    downstream Number
    Total downstream usage in network, in KB
    upstream Number
    Total upstream usage in network, in KB

    GetSummaryTopNetworksByStatusItemDevices

    GetSummaryTopNetworksByStatusItemDevicesByProductType

    ProductType string
    Product type
    Url string
    URL to clients list for the relevant product type
    ProductType string
    Product type
    Url string
    URL to clients list for the relevant product type
    productType String
    Product type
    url String
    URL to clients list for the relevant product type
    productType string
    Product type
    url string
    URL to clients list for the relevant product type
    product_type str
    Product type
    url str
    URL to clients list for the relevant product type
    productType String
    Product type
    url String
    URL to clients list for the relevant product type

    GetSummaryTopNetworksByStatusItemStatuses

    ByProductTypes List<GetSummaryTopNetworksByStatusItemStatusesByProductType>
    List of status counts by product type
    Overall string
    Overall status of network
    ByProductTypes []GetSummaryTopNetworksByStatusItemStatusesByProductType
    List of status counts by product type
    Overall string
    Overall status of network
    byProductTypes List<GetSummaryTopNetworksByStatusItemStatusesByProductType>
    List of status counts by product type
    overall String
    Overall status of network
    byProductTypes GetSummaryTopNetworksByStatusItemStatusesByProductType[]
    List of status counts by product type
    overall string
    Overall status of network
    by_product_types Sequence[GetSummaryTopNetworksByStatusItemStatusesByProductType]
    List of status counts by product type
    overall str
    Overall status of network
    byProductTypes List<Property Map>
    List of status counts by product type
    overall String
    Overall status of network

    GetSummaryTopNetworksByStatusItemStatusesByProductType

    counts Property Map
    Counts of devices by status
    productType String
    Product type

    GetSummaryTopNetworksByStatusItemStatusesByProductTypeCounts

    Alerting int
    Count of alerting devices
    Dormant int
    Count of dormant devices
    Offline int
    Count of offline devices
    Online int
    Count of online devices
    Alerting int
    Count of alerting devices
    Dormant int
    Count of dormant devices
    Offline int
    Count of offline devices
    Online int
    Count of online devices
    alerting Integer
    Count of alerting devices
    dormant Integer
    Count of dormant devices
    offline Integer
    Count of offline devices
    online Integer
    Count of online devices
    alerting number
    Count of alerting devices
    dormant number
    Count of dormant devices
    offline number
    Count of offline devices
    online number
    Count of online devices
    alerting int
    Count of alerting devices
    dormant int
    Count of dormant devices
    offline int
    Count of offline devices
    online int
    Count of online devices
    alerting Number
    Count of alerting devices
    dormant Number
    Count of dormant devices
    offline Number
    Count of offline devices
    online Number
    Count of online devices

    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