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

meraki.organizations.getDevices

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.getDevices({
        configurationUpdatedAfter: "string",
        endingBefore: "string",
        mac: "string",
        macs: ["string"],
        model: "string",
        models: ["string"],
        name: "string",
        networkIds: ["string"],
        organizationId: "string",
        perPage: 1,
        productTypes: ["string"],
        sensorAlertProfileIds: ["string"],
        sensorMetrics: ["string"],
        serial: "string",
        serials: ["string"],
        startingAfter: "string",
        tags: ["string"],
        tagsFilterType: "string",
    });
    export const merakiOrganizationsDevicesExample = example.then(example => example.items);
    
    import pulumi
    import pulumi_meraki as meraki
    
    example = meraki.organizations.get_devices(configuration_updated_after="string",
        ending_before="string",
        mac="string",
        macs=["string"],
        model="string",
        models=["string"],
        name="string",
        network_ids=["string"],
        organization_id="string",
        per_page=1,
        product_types=["string"],
        sensor_alert_profile_ids=["string"],
        sensor_metrics=["string"],
        serial="string",
        serials=["string"],
        starting_after="string",
        tags=["string"],
        tags_filter_type="string")
    pulumi.export("merakiOrganizationsDevicesExample", 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.GetDevices(ctx, &organizations.GetDevicesArgs{
    			ConfigurationUpdatedAfter: pulumi.StringRef("string"),
    			EndingBefore:              pulumi.StringRef("string"),
    			Mac:                       pulumi.StringRef("string"),
    			Macs: []string{
    				"string",
    			},
    			Model: pulumi.StringRef("string"),
    			Models: []string{
    				"string",
    			},
    			Name: pulumi.StringRef("string"),
    			NetworkIds: []string{
    				"string",
    			},
    			OrganizationId: "string",
    			PerPage:        pulumi.IntRef(1),
    			ProductTypes: []string{
    				"string",
    			},
    			SensorAlertProfileIds: []string{
    				"string",
    			},
    			SensorMetrics: []string{
    				"string",
    			},
    			Serial: pulumi.StringRef("string"),
    			Serials: []string{
    				"string",
    			},
    			StartingAfter: pulumi.StringRef("string"),
    			Tags: []string{
    				"string",
    			},
    			TagsFilterType: pulumi.StringRef("string"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("merakiOrganizationsDevicesExample", 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.GetDevices.Invoke(new()
        {
            ConfigurationUpdatedAfter = "string",
            EndingBefore = "string",
            Mac = "string",
            Macs = new[]
            {
                "string",
            },
            Model = "string",
            Models = new[]
            {
                "string",
            },
            Name = "string",
            NetworkIds = new[]
            {
                "string",
            },
            OrganizationId = "string",
            PerPage = 1,
            ProductTypes = new[]
            {
                "string",
            },
            SensorAlertProfileIds = new[]
            {
                "string",
            },
            SensorMetrics = new[]
            {
                "string",
            },
            Serial = "string",
            Serials = new[]
            {
                "string",
            },
            StartingAfter = "string",
            Tags = new[]
            {
                "string",
            },
            TagsFilterType = "string",
        });
    
        return new Dictionary<string, object?>
        {
            ["merakiOrganizationsDevicesExample"] = example.Apply(getDevicesResult => getDevicesResult.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.GetDevicesArgs;
    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.getDevices(GetDevicesArgs.builder()
                .configurationUpdatedAfter("string")
                .endingBefore("string")
                .mac("string")
                .macs("string")
                .model("string")
                .models("string")
                .name("string")
                .networkIds("string")
                .organizationId("string")
                .perPage(1)
                .productTypes("string")
                .sensorAlertProfileIds("string")
                .sensorMetrics("string")
                .serial("string")
                .serials("string")
                .startingAfter("string")
                .tags("string")
                .tagsFilterType("string")
                .build());
    
            ctx.export("merakiOrganizationsDevicesExample", example.applyValue(getDevicesResult -> getDevicesResult.items()));
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: meraki:organizations:getDevices
          Arguments:
            configurationUpdatedAfter: string
            endingBefore: string
            mac: string
            macs:
              - string
            model: string
            models:
              - string
            name: string
            networkIds:
              - string
            organizationId: string
            perPage: 1
            productTypes:
              - string
            sensorAlertProfileIds:
              - string
            sensorMetrics:
              - string
            serial: string
            serials:
              - string
            startingAfter: string
            tags:
              - string
            tagsFilterType: string
    outputs:
      merakiOrganizationsDevicesExample: ${example.items}
    

    Using getDevices

    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 getDevices(args: GetDevicesArgs, opts?: InvokeOptions): Promise<GetDevicesResult>
    function getDevicesOutput(args: GetDevicesOutputArgs, opts?: InvokeOptions): Output<GetDevicesResult>
    def get_devices(configuration_updated_after: Optional[str] = None,
                    ending_before: Optional[str] = None,
                    mac: Optional[str] = None,
                    macs: Optional[Sequence[str]] = None,
                    model: Optional[str] = None,
                    models: Optional[Sequence[str]] = None,
                    name: Optional[str] = None,
                    network_ids: Optional[Sequence[str]] = None,
                    organization_id: Optional[str] = None,
                    per_page: Optional[int] = None,
                    product_types: Optional[Sequence[str]] = None,
                    sensor_alert_profile_ids: Optional[Sequence[str]] = None,
                    sensor_metrics: Optional[Sequence[str]] = None,
                    serial: Optional[str] = None,
                    serials: Optional[Sequence[str]] = None,
                    starting_after: Optional[str] = None,
                    tags: Optional[Sequence[str]] = None,
                    tags_filter_type: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetDevicesResult
    def get_devices_output(configuration_updated_after: Optional[pulumi.Input[str]] = None,
                    ending_before: Optional[pulumi.Input[str]] = None,
                    mac: Optional[pulumi.Input[str]] = None,
                    macs: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                    model: Optional[pulumi.Input[str]] = None,
                    models: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                    name: Optional[pulumi.Input[str]] = None,
                    network_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                    organization_id: Optional[pulumi.Input[str]] = None,
                    per_page: Optional[pulumi.Input[int]] = None,
                    product_types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                    sensor_alert_profile_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                    sensor_metrics: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                    serial: Optional[pulumi.Input[str]] = None,
                    serials: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                    starting_after: Optional[pulumi.Input[str]] = None,
                    tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                    tags_filter_type: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetDevicesResult]
    func GetDevices(ctx *Context, args *GetDevicesArgs, opts ...InvokeOption) (*GetDevicesResult, error)
    func GetDevicesOutput(ctx *Context, args *GetDevicesOutputArgs, opts ...InvokeOption) GetDevicesResultOutput

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

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

    The following arguments are supported:

    OrganizationId string
    organizationId path parameter. Organization ID
    ConfigurationUpdatedAfter string
    configurationUpdatedAfter query parameter. Filter results by whether or not the device's configuration has been updated after the given timestamp
    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.
    Mac string
    mac query parameter. Optional parameter to filter devices by MAC address. All returned devices will have a MAC address that contains the search term or is an exact match.
    Macs List<string>
    macs query parameter. Optional parameter to filter devices by one or more MAC addresses. All returned devices will have a MAC address that is an exact match.
    Model string
    model query parameter. Optional parameter to filter devices by model. All returned devices will have a model that contains the search term or is an exact match.
    Models List<string>
    models query parameter. Optional parameter to filter devices by one or more models. All returned devices will have a model that is an exact match.
    Name string
    name query parameter. Optional parameter to filter devices by name. All returned devices will have a name that contains the search term or is an exact match.
    NetworkIds List<string>
    networkIds query parameter. Optional parameter to filter devices by network.
    PerPage int
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 1000.
    ProductTypes List<string>
    productTypes query parameter. Optional parameter to filter devices by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.
    SensorAlertProfileIds List<string>
    sensorAlertProfileIds query parameter. Optional parameter to filter devices by the alert profiles that are bound to them. Only applies to sensor devices.
    SensorMetrics List<string>
    sensorMetrics query parameter. Optional parameter to filter devices by the metrics that they provide. Only applies to sensor devices.
    Serial string
    serial query parameter. Optional parameter to filter devices by serial number. All returned devices will have a serial number that contains the search term or is an exact match.
    Serials List<string>
    serials query parameter. Optional parameter to filter devices by one or more serial numbers. All returned devices will have a serial number that is an exact match.
    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.
    Tags List<string>
    tags query parameter. Optional parameter to filter devices by tags.
    TagsFilterType string
    tagsFilterType query parameter. Optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected.
    OrganizationId string
    organizationId path parameter. Organization ID
    ConfigurationUpdatedAfter string
    configurationUpdatedAfter query parameter. Filter results by whether or not the device's configuration has been updated after the given timestamp
    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.
    Mac string
    mac query parameter. Optional parameter to filter devices by MAC address. All returned devices will have a MAC address that contains the search term or is an exact match.
    Macs []string
    macs query parameter. Optional parameter to filter devices by one or more MAC addresses. All returned devices will have a MAC address that is an exact match.
    Model string
    model query parameter. Optional parameter to filter devices by model. All returned devices will have a model that contains the search term or is an exact match.
    Models []string
    models query parameter. Optional parameter to filter devices by one or more models. All returned devices will have a model that is an exact match.
    Name string
    name query parameter. Optional parameter to filter devices by name. All returned devices will have a name that contains the search term or is an exact match.
    NetworkIds []string
    networkIds query parameter. Optional parameter to filter devices by network.
    PerPage int
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 1000.
    ProductTypes []string
    productTypes query parameter. Optional parameter to filter devices by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.
    SensorAlertProfileIds []string
    sensorAlertProfileIds query parameter. Optional parameter to filter devices by the alert profiles that are bound to them. Only applies to sensor devices.
    SensorMetrics []string
    sensorMetrics query parameter. Optional parameter to filter devices by the metrics that they provide. Only applies to sensor devices.
    Serial string
    serial query parameter. Optional parameter to filter devices by serial number. All returned devices will have a serial number that contains the search term or is an exact match.
    Serials []string
    serials query parameter. Optional parameter to filter devices by one or more serial numbers. All returned devices will have a serial number that is an exact match.
    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.
    Tags []string
    tags query parameter. Optional parameter to filter devices by tags.
    TagsFilterType string
    tagsFilterType query parameter. Optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected.
    organizationId String
    organizationId path parameter. Organization ID
    configurationUpdatedAfter String
    configurationUpdatedAfter query parameter. Filter results by whether or not the device's configuration has been updated after the given timestamp
    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.
    mac String
    mac query parameter. Optional parameter to filter devices by MAC address. All returned devices will have a MAC address that contains the search term or is an exact match.
    macs List<String>
    macs query parameter. Optional parameter to filter devices by one or more MAC addresses. All returned devices will have a MAC address that is an exact match.
    model String
    model query parameter. Optional parameter to filter devices by model. All returned devices will have a model that contains the search term or is an exact match.
    models List<String>
    models query parameter. Optional parameter to filter devices by one or more models. All returned devices will have a model that is an exact match.
    name String
    name query parameter. Optional parameter to filter devices by name. All returned devices will have a name that contains the search term or is an exact match.
    networkIds List<String>
    networkIds query parameter. Optional parameter to filter devices by network.
    perPage Integer
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 1000.
    productTypes List<String>
    productTypes query parameter. Optional parameter to filter devices by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.
    sensorAlertProfileIds List<String>
    sensorAlertProfileIds query parameter. Optional parameter to filter devices by the alert profiles that are bound to them. Only applies to sensor devices.
    sensorMetrics List<String>
    sensorMetrics query parameter. Optional parameter to filter devices by the metrics that they provide. Only applies to sensor devices.
    serial String
    serial query parameter. Optional parameter to filter devices by serial number. All returned devices will have a serial number that contains the search term or is an exact match.
    serials List<String>
    serials query parameter. Optional parameter to filter devices by one or more serial numbers. All returned devices will have a serial number that is an exact match.
    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.
    tags List<String>
    tags query parameter. Optional parameter to filter devices by tags.
    tagsFilterType String
    tagsFilterType query parameter. Optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected.
    organizationId string
    organizationId path parameter. Organization ID
    configurationUpdatedAfter string
    configurationUpdatedAfter query parameter. Filter results by whether or not the device's configuration has been updated after the given timestamp
    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.
    mac string
    mac query parameter. Optional parameter to filter devices by MAC address. All returned devices will have a MAC address that contains the search term or is an exact match.
    macs string[]
    macs query parameter. Optional parameter to filter devices by one or more MAC addresses. All returned devices will have a MAC address that is an exact match.
    model string
    model query parameter. Optional parameter to filter devices by model. All returned devices will have a model that contains the search term or is an exact match.
    models string[]
    models query parameter. Optional parameter to filter devices by one or more models. All returned devices will have a model that is an exact match.
    name string
    name query parameter. Optional parameter to filter devices by name. All returned devices will have a name that contains the search term or is an exact match.
    networkIds string[]
    networkIds query parameter. Optional parameter to filter devices by network.
    perPage number
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 1000.
    productTypes string[]
    productTypes query parameter. Optional parameter to filter devices by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.
    sensorAlertProfileIds string[]
    sensorAlertProfileIds query parameter. Optional parameter to filter devices by the alert profiles that are bound to them. Only applies to sensor devices.
    sensorMetrics string[]
    sensorMetrics query parameter. Optional parameter to filter devices by the metrics that they provide. Only applies to sensor devices.
    serial string
    serial query parameter. Optional parameter to filter devices by serial number. All returned devices will have a serial number that contains the search term or is an exact match.
    serials string[]
    serials query parameter. Optional parameter to filter devices by one or more serial numbers. All returned devices will have a serial number that is an exact match.
    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.
    tags string[]
    tags query parameter. Optional parameter to filter devices by tags.
    tagsFilterType string
    tagsFilterType query parameter. Optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected.
    organization_id str
    organizationId path parameter. Organization ID
    configuration_updated_after str
    configurationUpdatedAfter query parameter. Filter results by whether or not the device's configuration has been updated after the given timestamp
    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.
    mac str
    mac query parameter. Optional parameter to filter devices by MAC address. All returned devices will have a MAC address that contains the search term or is an exact match.
    macs Sequence[str]
    macs query parameter. Optional parameter to filter devices by one or more MAC addresses. All returned devices will have a MAC address that is an exact match.
    model str
    model query parameter. Optional parameter to filter devices by model. All returned devices will have a model that contains the search term or is an exact match.
    models Sequence[str]
    models query parameter. Optional parameter to filter devices by one or more models. All returned devices will have a model that is an exact match.
    name str
    name query parameter. Optional parameter to filter devices by name. All returned devices will have a name that contains the search term or is an exact match.
    network_ids Sequence[str]
    networkIds query parameter. Optional parameter to filter devices by network.
    per_page int
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 1000.
    product_types Sequence[str]
    productTypes query parameter. Optional parameter to filter devices by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.
    sensor_alert_profile_ids Sequence[str]
    sensorAlertProfileIds query parameter. Optional parameter to filter devices by the alert profiles that are bound to them. Only applies to sensor devices.
    sensor_metrics Sequence[str]
    sensorMetrics query parameter. Optional parameter to filter devices by the metrics that they provide. Only applies to sensor devices.
    serial str
    serial query parameter. Optional parameter to filter devices by serial number. All returned devices will have a serial number that contains the search term or is an exact match.
    serials Sequence[str]
    serials query parameter. Optional parameter to filter devices by one or more serial numbers. All returned devices will have a serial number that is an exact match.
    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.
    tags Sequence[str]
    tags query parameter. Optional parameter to filter devices by tags.
    tags_filter_type str
    tagsFilterType query parameter. Optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected.
    organizationId String
    organizationId path parameter. Organization ID
    configurationUpdatedAfter String
    configurationUpdatedAfter query parameter. Filter results by whether or not the device's configuration has been updated after the given timestamp
    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.
    mac String
    mac query parameter. Optional parameter to filter devices by MAC address. All returned devices will have a MAC address that contains the search term or is an exact match.
    macs List<String>
    macs query parameter. Optional parameter to filter devices by one or more MAC addresses. All returned devices will have a MAC address that is an exact match.
    model String
    model query parameter. Optional parameter to filter devices by model. All returned devices will have a model that contains the search term or is an exact match.
    models List<String>
    models query parameter. Optional parameter to filter devices by one or more models. All returned devices will have a model that is an exact match.
    name String
    name query parameter. Optional parameter to filter devices by name. All returned devices will have a name that contains the search term or is an exact match.
    networkIds List<String>
    networkIds query parameter. Optional parameter to filter devices by network.
    perPage Number
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 1000.
    productTypes List<String>
    productTypes query parameter. Optional parameter to filter devices by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.
    sensorAlertProfileIds List<String>
    sensorAlertProfileIds query parameter. Optional parameter to filter devices by the alert profiles that are bound to them. Only applies to sensor devices.
    sensorMetrics List<String>
    sensorMetrics query parameter. Optional parameter to filter devices by the metrics that they provide. Only applies to sensor devices.
    serial String
    serial query parameter. Optional parameter to filter devices by serial number. All returned devices will have a serial number that contains the search term or is an exact match.
    serials List<String>
    serials query parameter. Optional parameter to filter devices by one or more serial numbers. All returned devices will have a serial number that is an exact match.
    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.
    tags List<String>
    tags query parameter. Optional parameter to filter devices by tags.
    tagsFilterType String
    tagsFilterType query parameter. Optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected.

    getDevices Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Items List<GetDevicesItem>
    Array of ResponseOrganizationsGetOrganizationDevices
    OrganizationId string
    organizationId path parameter. Organization ID
    ConfigurationUpdatedAfter string
    configurationUpdatedAfter query parameter. Filter results by whether or not the device's configuration has been updated after the given timestamp
    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.
    Mac string
    mac query parameter. Optional parameter to filter devices by MAC address. All returned devices will have a MAC address that contains the search term or is an exact match.
    Macs List<string>
    macs query parameter. Optional parameter to filter devices by one or more MAC addresses. All returned devices will have a MAC address that is an exact match.
    Model string
    model query parameter. Optional parameter to filter devices by model. All returned devices will have a model that contains the search term or is an exact match.
    Models List<string>
    models query parameter. Optional parameter to filter devices by one or more models. All returned devices will have a model that is an exact match.
    Name string
    name query parameter. Optional parameter to filter devices by name. All returned devices will have a name that contains the search term or is an exact match.
    NetworkIds List<string>
    networkIds query parameter. Optional parameter to filter devices by network.
    PerPage int
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 1000.
    ProductTypes List<string>
    productTypes query parameter. Optional parameter to filter devices by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.
    SensorAlertProfileIds List<string>
    sensorAlertProfileIds query parameter. Optional parameter to filter devices by the alert profiles that are bound to them. Only applies to sensor devices.
    SensorMetrics List<string>
    sensorMetrics query parameter. Optional parameter to filter devices by the metrics that they provide. Only applies to sensor devices.
    Serial string
    serial query parameter. Optional parameter to filter devices by serial number. All returned devices will have a serial number that contains the search term or is an exact match.
    Serials List<string>
    serials query parameter. Optional parameter to filter devices by one or more serial numbers. All returned devices will have a serial number that is an exact match.
    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.
    Tags List<string>
    tags query parameter. Optional parameter to filter devices by tags.
    TagsFilterType string
    tagsFilterType query parameter. Optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected.
    Id string
    The provider-assigned unique ID for this managed resource.
    Items []GetDevicesItem
    Array of ResponseOrganizationsGetOrganizationDevices
    OrganizationId string
    organizationId path parameter. Organization ID
    ConfigurationUpdatedAfter string
    configurationUpdatedAfter query parameter. Filter results by whether or not the device's configuration has been updated after the given timestamp
    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.
    Mac string
    mac query parameter. Optional parameter to filter devices by MAC address. All returned devices will have a MAC address that contains the search term or is an exact match.
    Macs []string
    macs query parameter. Optional parameter to filter devices by one or more MAC addresses. All returned devices will have a MAC address that is an exact match.
    Model string
    model query parameter. Optional parameter to filter devices by model. All returned devices will have a model that contains the search term or is an exact match.
    Models []string
    models query parameter. Optional parameter to filter devices by one or more models. All returned devices will have a model that is an exact match.
    Name string
    name query parameter. Optional parameter to filter devices by name. All returned devices will have a name that contains the search term or is an exact match.
    NetworkIds []string
    networkIds query parameter. Optional parameter to filter devices by network.
    PerPage int
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 1000.
    ProductTypes []string
    productTypes query parameter. Optional parameter to filter devices by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.
    SensorAlertProfileIds []string
    sensorAlertProfileIds query parameter. Optional parameter to filter devices by the alert profiles that are bound to them. Only applies to sensor devices.
    SensorMetrics []string
    sensorMetrics query parameter. Optional parameter to filter devices by the metrics that they provide. Only applies to sensor devices.
    Serial string
    serial query parameter. Optional parameter to filter devices by serial number. All returned devices will have a serial number that contains the search term or is an exact match.
    Serials []string
    serials query parameter. Optional parameter to filter devices by one or more serial numbers. All returned devices will have a serial number that is an exact match.
    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.
    Tags []string
    tags query parameter. Optional parameter to filter devices by tags.
    TagsFilterType string
    tagsFilterType query parameter. Optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected.
    id String
    The provider-assigned unique ID for this managed resource.
    items List<GetDevicesItem>
    Array of ResponseOrganizationsGetOrganizationDevices
    organizationId String
    organizationId path parameter. Organization ID
    configurationUpdatedAfter String
    configurationUpdatedAfter query parameter. Filter results by whether or not the device's configuration has been updated after the given timestamp
    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.
    mac String
    mac query parameter. Optional parameter to filter devices by MAC address. All returned devices will have a MAC address that contains the search term or is an exact match.
    macs List<String>
    macs query parameter. Optional parameter to filter devices by one or more MAC addresses. All returned devices will have a MAC address that is an exact match.
    model String
    model query parameter. Optional parameter to filter devices by model. All returned devices will have a model that contains the search term or is an exact match.
    models List<String>
    models query parameter. Optional parameter to filter devices by one or more models. All returned devices will have a model that is an exact match.
    name String
    name query parameter. Optional parameter to filter devices by name. All returned devices will have a name that contains the search term or is an exact match.
    networkIds List<String>
    networkIds query parameter. Optional parameter to filter devices by network.
    perPage Integer
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 1000.
    productTypes List<String>
    productTypes query parameter. Optional parameter to filter devices by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.
    sensorAlertProfileIds List<String>
    sensorAlertProfileIds query parameter. Optional parameter to filter devices by the alert profiles that are bound to them. Only applies to sensor devices.
    sensorMetrics List<String>
    sensorMetrics query parameter. Optional parameter to filter devices by the metrics that they provide. Only applies to sensor devices.
    serial String
    serial query parameter. Optional parameter to filter devices by serial number. All returned devices will have a serial number that contains the search term or is an exact match.
    serials List<String>
    serials query parameter. Optional parameter to filter devices by one or more serial numbers. All returned devices will have a serial number that is an exact match.
    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.
    tags List<String>
    tags query parameter. Optional parameter to filter devices by tags.
    tagsFilterType String
    tagsFilterType query parameter. Optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected.
    id string
    The provider-assigned unique ID for this managed resource.
    items GetDevicesItem[]
    Array of ResponseOrganizationsGetOrganizationDevices
    organizationId string
    organizationId path parameter. Organization ID
    configurationUpdatedAfter string
    configurationUpdatedAfter query parameter. Filter results by whether or not the device's configuration has been updated after the given timestamp
    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.
    mac string
    mac query parameter. Optional parameter to filter devices by MAC address. All returned devices will have a MAC address that contains the search term or is an exact match.
    macs string[]
    macs query parameter. Optional parameter to filter devices by one or more MAC addresses. All returned devices will have a MAC address that is an exact match.
    model string
    model query parameter. Optional parameter to filter devices by model. All returned devices will have a model that contains the search term or is an exact match.
    models string[]
    models query parameter. Optional parameter to filter devices by one or more models. All returned devices will have a model that is an exact match.
    name string
    name query parameter. Optional parameter to filter devices by name. All returned devices will have a name that contains the search term or is an exact match.
    networkIds string[]
    networkIds query parameter. Optional parameter to filter devices by network.
    perPage number
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 1000.
    productTypes string[]
    productTypes query parameter. Optional parameter to filter devices by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.
    sensorAlertProfileIds string[]
    sensorAlertProfileIds query parameter. Optional parameter to filter devices by the alert profiles that are bound to them. Only applies to sensor devices.
    sensorMetrics string[]
    sensorMetrics query parameter. Optional parameter to filter devices by the metrics that they provide. Only applies to sensor devices.
    serial string
    serial query parameter. Optional parameter to filter devices by serial number. All returned devices will have a serial number that contains the search term or is an exact match.
    serials string[]
    serials query parameter. Optional parameter to filter devices by one or more serial numbers. All returned devices will have a serial number that is an exact match.
    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.
    tags string[]
    tags query parameter. Optional parameter to filter devices by tags.
    tagsFilterType string
    tagsFilterType query parameter. Optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected.
    id str
    The provider-assigned unique ID for this managed resource.
    items Sequence[GetDevicesItem]
    Array of ResponseOrganizationsGetOrganizationDevices
    organization_id str
    organizationId path parameter. Organization ID
    configuration_updated_after str
    configurationUpdatedAfter query parameter. Filter results by whether or not the device's configuration has been updated after the given timestamp
    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.
    mac str
    mac query parameter. Optional parameter to filter devices by MAC address. All returned devices will have a MAC address that contains the search term or is an exact match.
    macs Sequence[str]
    macs query parameter. Optional parameter to filter devices by one or more MAC addresses. All returned devices will have a MAC address that is an exact match.
    model str
    model query parameter. Optional parameter to filter devices by model. All returned devices will have a model that contains the search term or is an exact match.
    models Sequence[str]
    models query parameter. Optional parameter to filter devices by one or more models. All returned devices will have a model that is an exact match.
    name str
    name query parameter. Optional parameter to filter devices by name. All returned devices will have a name that contains the search term or is an exact match.
    network_ids Sequence[str]
    networkIds query parameter. Optional parameter to filter devices by network.
    per_page int
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 1000.
    product_types Sequence[str]
    productTypes query parameter. Optional parameter to filter devices by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.
    sensor_alert_profile_ids Sequence[str]
    sensorAlertProfileIds query parameter. Optional parameter to filter devices by the alert profiles that are bound to them. Only applies to sensor devices.
    sensor_metrics Sequence[str]
    sensorMetrics query parameter. Optional parameter to filter devices by the metrics that they provide. Only applies to sensor devices.
    serial str
    serial query parameter. Optional parameter to filter devices by serial number. All returned devices will have a serial number that contains the search term or is an exact match.
    serials Sequence[str]
    serials query parameter. Optional parameter to filter devices by one or more serial numbers. All returned devices will have a serial number that is an exact match.
    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.
    tags Sequence[str]
    tags query parameter. Optional parameter to filter devices by tags.
    tags_filter_type str
    tagsFilterType query parameter. Optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected.
    id String
    The provider-assigned unique ID for this managed resource.
    items List<Property Map>
    Array of ResponseOrganizationsGetOrganizationDevices
    organizationId String
    organizationId path parameter. Organization ID
    configurationUpdatedAfter String
    configurationUpdatedAfter query parameter. Filter results by whether or not the device's configuration has been updated after the given timestamp
    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.
    mac String
    mac query parameter. Optional parameter to filter devices by MAC address. All returned devices will have a MAC address that contains the search term or is an exact match.
    macs List<String>
    macs query parameter. Optional parameter to filter devices by one or more MAC addresses. All returned devices will have a MAC address that is an exact match.
    model String
    model query parameter. Optional parameter to filter devices by model. All returned devices will have a model that contains the search term or is an exact match.
    models List<String>
    models query parameter. Optional parameter to filter devices by one or more models. All returned devices will have a model that is an exact match.
    name String
    name query parameter. Optional parameter to filter devices by name. All returned devices will have a name that contains the search term or is an exact match.
    networkIds List<String>
    networkIds query parameter. Optional parameter to filter devices by network.
    perPage Number
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 1000.
    productTypes List<String>
    productTypes query parameter. Optional parameter to filter devices by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.
    sensorAlertProfileIds List<String>
    sensorAlertProfileIds query parameter. Optional parameter to filter devices by the alert profiles that are bound to them. Only applies to sensor devices.
    sensorMetrics List<String>
    sensorMetrics query parameter. Optional parameter to filter devices by the metrics that they provide. Only applies to sensor devices.
    serial String
    serial query parameter. Optional parameter to filter devices by serial number. All returned devices will have a serial number that contains the search term or is an exact match.
    serials List<String>
    serials query parameter. Optional parameter to filter devices by one or more serial numbers. All returned devices will have a serial number that is an exact match.
    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.
    tags List<String>
    tags query parameter. Optional parameter to filter devices by tags.
    tagsFilterType String
    tagsFilterType query parameter. Optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected.

    Supporting Types

    GetDevicesItem

    Address string
    Physical address of the device
    Details List<GetDevicesItemDetail>
    Additional device information
    Firmware string
    Firmware version of the device
    Imei string
    IMEI of the device, if applicable
    LanIp string
    LAN IP address of the device
    Lat double
    Latitude of the device
    Lng double
    Longitude of the device
    Mac string
    MAC address of the device
    Model string
    Model of the device
    Name string
    Name of the device
    NetworkId string
    ID of the network the device belongs to
    Notes string
    Notes for the device, limited to 255 characters
    ProductType string
    Product type of the device
    Serial string
    Serial number of the device
    Tags List<string>
    List of tags assigned to the device
    Address string
    Physical address of the device
    Details []GetDevicesItemDetail
    Additional device information
    Firmware string
    Firmware version of the device
    Imei string
    IMEI of the device, if applicable
    LanIp string
    LAN IP address of the device
    Lat float64
    Latitude of the device
    Lng float64
    Longitude of the device
    Mac string
    MAC address of the device
    Model string
    Model of the device
    Name string
    Name of the device
    NetworkId string
    ID of the network the device belongs to
    Notes string
    Notes for the device, limited to 255 characters
    ProductType string
    Product type of the device
    Serial string
    Serial number of the device
    Tags []string
    List of tags assigned to the device
    address String
    Physical address of the device
    details List<GetDevicesItemDetail>
    Additional device information
    firmware String
    Firmware version of the device
    imei String
    IMEI of the device, if applicable
    lanIp String
    LAN IP address of the device
    lat Double
    Latitude of the device
    lng Double
    Longitude of the device
    mac String
    MAC address of the device
    model String
    Model of the device
    name String
    Name of the device
    networkId String
    ID of the network the device belongs to
    notes String
    Notes for the device, limited to 255 characters
    productType String
    Product type of the device
    serial String
    Serial number of the device
    tags List<String>
    List of tags assigned to the device
    address string
    Physical address of the device
    details GetDevicesItemDetail[]
    Additional device information
    firmware string
    Firmware version of the device
    imei string
    IMEI of the device, if applicable
    lanIp string
    LAN IP address of the device
    lat number
    Latitude of the device
    lng number
    Longitude of the device
    mac string
    MAC address of the device
    model string
    Model of the device
    name string
    Name of the device
    networkId string
    ID of the network the device belongs to
    notes string
    Notes for the device, limited to 255 characters
    productType string
    Product type of the device
    serial string
    Serial number of the device
    tags string[]
    List of tags assigned to the device
    address str
    Physical address of the device
    details Sequence[GetDevicesItemDetail]
    Additional device information
    firmware str
    Firmware version of the device
    imei str
    IMEI of the device, if applicable
    lan_ip str
    LAN IP address of the device
    lat float
    Latitude of the device
    lng float
    Longitude of the device
    mac str
    MAC address of the device
    model str
    Model of the device
    name str
    Name of the device
    network_id str
    ID of the network the device belongs to
    notes str
    Notes for the device, limited to 255 characters
    product_type str
    Product type of the device
    serial str
    Serial number of the device
    tags Sequence[str]
    List of tags assigned to the device
    address String
    Physical address of the device
    details List<Property Map>
    Additional device information
    firmware String
    Firmware version of the device
    imei String
    IMEI of the device, if applicable
    lanIp String
    LAN IP address of the device
    lat Number
    Latitude of the device
    lng Number
    Longitude of the device
    mac String
    MAC address of the device
    model String
    Model of the device
    name String
    Name of the device
    networkId String
    ID of the network the device belongs to
    notes String
    Notes for the device, limited to 255 characters
    productType String
    Product type of the device
    serial String
    Serial number of the device
    tags List<String>
    List of tags assigned to the device

    GetDevicesItemDetail

    Name string
    Additional property name
    Value string
    Additional property value
    Name string
    Additional property name
    Value string
    Additional property value
    name String
    Additional property name
    value String
    Additional property value
    name string
    Additional property name
    value string
    Additional property value
    name str
    Additional property name
    value str
    Additional property value
    name String
    Additional property name
    value String
    Additional property value

    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