1. Packages
  2. Cisco Meraki
  3. API Docs
  4. organizations
  5. getDevicesStatusesOverview
Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi

meraki.organizations.getDevicesStatusesOverview

Explore with Pulumi AI

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as meraki from "@pulumi/meraki";
    
    const example = meraki.organizations.getDevicesStatusesOverview({
        networkIds: ["string"],
        organizationId: "string",
        productTypes: ["string"],
    });
    export const merakiOrganizationsDevicesStatusesOverviewExample = example.then(example => example.item);
    
    import pulumi
    import pulumi_meraki as meraki
    
    example = meraki.organizations.get_devices_statuses_overview(network_ids=["string"],
        organization_id="string",
        product_types=["string"])
    pulumi.export("merakiOrganizationsDevicesStatusesOverviewExample", 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.GetDevicesStatusesOverview(ctx, &organizations.GetDevicesStatusesOverviewArgs{
    			NetworkIds: []string{
    				"string",
    			},
    			OrganizationId: "string",
    			ProductTypes: []string{
    				"string",
    			},
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("merakiOrganizationsDevicesStatusesOverviewExample", 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.GetDevicesStatusesOverview.Invoke(new()
        {
            NetworkIds = new[]
            {
                "string",
            },
            OrganizationId = "string",
            ProductTypes = new[]
            {
                "string",
            },
        });
    
        return new Dictionary<string, object?>
        {
            ["merakiOrganizationsDevicesStatusesOverviewExample"] = example.Apply(getDevicesStatusesOverviewResult => getDevicesStatusesOverviewResult.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.GetDevicesStatusesOverviewArgs;
    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.getDevicesStatusesOverview(GetDevicesStatusesOverviewArgs.builder()
                .networkIds("string")
                .organizationId("string")
                .productTypes("string")
                .build());
    
            ctx.export("merakiOrganizationsDevicesStatusesOverviewExample", example.applyValue(getDevicesStatusesOverviewResult -> getDevicesStatusesOverviewResult.item()));
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: meraki:organizations:getDevicesStatusesOverview
          Arguments:
            networkIds:
              - string
            organizationId: string
            productTypes:
              - string
    outputs:
      merakiOrganizationsDevicesStatusesOverviewExample: ${example.item}
    

    Using getDevicesStatusesOverview

    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 getDevicesStatusesOverview(args: GetDevicesStatusesOverviewArgs, opts?: InvokeOptions): Promise<GetDevicesStatusesOverviewResult>
    function getDevicesStatusesOverviewOutput(args: GetDevicesStatusesOverviewOutputArgs, opts?: InvokeOptions): Output<GetDevicesStatusesOverviewResult>
    def get_devices_statuses_overview(network_ids: Optional[Sequence[str]] = None,
                                      organization_id: Optional[str] = None,
                                      product_types: Optional[Sequence[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetDevicesStatusesOverviewResult
    def get_devices_statuses_overview_output(network_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                      organization_id: Optional[pulumi.Input[str]] = None,
                                      product_types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetDevicesStatusesOverviewResult]
    func GetDevicesStatusesOverview(ctx *Context, args *GetDevicesStatusesOverviewArgs, opts ...InvokeOption) (*GetDevicesStatusesOverviewResult, error)
    func GetDevicesStatusesOverviewOutput(ctx *Context, args *GetDevicesStatusesOverviewOutputArgs, opts ...InvokeOption) GetDevicesStatusesOverviewResultOutput

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

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

    The following arguments are supported:

    OrganizationId string
    organizationId path parameter. Organization ID
    NetworkIds List<string>
    networkIds query parameter. An optional parameter to filter device statuses by network.
    ProductTypes List<string>
    productTypes query parameter. An optional parameter to filter device statuses by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.
    OrganizationId string
    organizationId path parameter. Organization ID
    NetworkIds []string
    networkIds query parameter. An optional parameter to filter device statuses by network.
    ProductTypes []string
    productTypes query parameter. An optional parameter to filter device statuses by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.
    organizationId String
    organizationId path parameter. Organization ID
    networkIds List<String>
    networkIds query parameter. An optional parameter to filter device statuses by network.
    productTypes List<String>
    productTypes query parameter. An optional parameter to filter device statuses by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.
    organizationId string
    organizationId path parameter. Organization ID
    networkIds string[]
    networkIds query parameter. An optional parameter to filter device statuses by network.
    productTypes string[]
    productTypes query parameter. An optional parameter to filter device statuses by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.
    organization_id str
    organizationId path parameter. Organization ID
    network_ids Sequence[str]
    networkIds query parameter. An optional parameter to filter device statuses by network.
    product_types Sequence[str]
    productTypes query parameter. An optional parameter to filter device statuses by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.
    organizationId String
    organizationId path parameter. Organization ID
    networkIds List<String>
    networkIds query parameter. An optional parameter to filter device statuses by network.
    productTypes List<String>
    productTypes query parameter. An optional parameter to filter device statuses by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.

    getDevicesStatusesOverview Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Item GetDevicesStatusesOverviewItem
    OrganizationId string
    organizationId path parameter. Organization ID
    NetworkIds List<string>
    networkIds query parameter. An optional parameter to filter device statuses by network.
    ProductTypes List<string>
    productTypes query parameter. An optional parameter to filter device statuses by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.
    Id string
    The provider-assigned unique ID for this managed resource.
    Item GetDevicesStatusesOverviewItem
    OrganizationId string
    organizationId path parameter. Organization ID
    NetworkIds []string
    networkIds query parameter. An optional parameter to filter device statuses by network.
    ProductTypes []string
    productTypes query parameter. An optional parameter to filter device statuses by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.
    id String
    The provider-assigned unique ID for this managed resource.
    item GetDevicesStatusesOverviewItem
    organizationId String
    organizationId path parameter. Organization ID
    networkIds List<String>
    networkIds query parameter. An optional parameter to filter device statuses by network.
    productTypes List<String>
    productTypes query parameter. An optional parameter to filter device statuses by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.
    id string
    The provider-assigned unique ID for this managed resource.
    item GetDevicesStatusesOverviewItem
    organizationId string
    organizationId path parameter. Organization ID
    networkIds string[]
    networkIds query parameter. An optional parameter to filter device statuses by network.
    productTypes string[]
    productTypes query parameter. An optional parameter to filter device statuses by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.
    id str
    The provider-assigned unique ID for this managed resource.
    item GetDevicesStatusesOverviewItem
    organization_id str
    organizationId path parameter. Organization ID
    network_ids Sequence[str]
    networkIds query parameter. An optional parameter to filter device statuses by network.
    product_types Sequence[str]
    productTypes query parameter. An optional parameter to filter device statuses by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.
    id String
    The provider-assigned unique ID for this managed resource.
    item Property Map
    organizationId String
    organizationId path parameter. Organization ID
    networkIds List<String>
    networkIds query parameter. An optional parameter to filter device statuses by network.
    productTypes List<String>
    productTypes query parameter. An optional parameter to filter device statuses by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.

    Supporting Types

    GetDevicesStatusesOverviewItem

    GetDevicesStatusesOverviewItemCounts

    GetDevicesStatusesOverviewItemCountsByStatus

    Alerting int
    alerting count
    Dormant int
    dormant count
    Offline int
    offline count
    Online int
    online count
    Alerting int
    alerting count
    Dormant int
    dormant count
    Offline int
    offline count
    Online int
    online count
    alerting Integer
    alerting count
    dormant Integer
    dormant count
    offline Integer
    offline count
    online Integer
    online count
    alerting number
    alerting count
    dormant number
    dormant count
    offline number
    offline count
    online number
    online count
    alerting int
    alerting count
    dormant int
    dormant count
    offline int
    offline count
    online int
    online count
    alerting Number
    alerting count
    dormant Number
    dormant count
    offline Number
    offline count
    online Number
    online count

    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