Cisco Meraki v0.4.1 published on Saturday, Mar 15, 2025 by Pulumi
meraki.networks.getEvents
Explore with Pulumi AI
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as meraki from "@pulumi/meraki";
const example = meraki.networks.getEvents({
    clientIp: "string",
    clientMac: "string",
    clientName: "string",
    deviceMac: "string",
    deviceName: "string",
    deviceSerial: "string",
    endingBefore: "string",
    excludedEventTypes: ["string"],
    includedEventTypes: ["string"],
    networkId: "string",
    perPage: 1,
    productType: "string",
    smDeviceMac: "string",
    smDeviceName: "string",
    startingAfter: "string",
});
export const merakiNetworksEventsExample = example.then(example => example.item);
import pulumi
import pulumi_meraki as meraki
example = meraki.networks.get_events(client_ip="string",
    client_mac="string",
    client_name="string",
    device_mac="string",
    device_name="string",
    device_serial="string",
    ending_before="string",
    excluded_event_types=["string"],
    included_event_types=["string"],
    network_id="string",
    per_page=1,
    product_type="string",
    sm_device_mac="string",
    sm_device_name="string",
    starting_after="string")
pulumi.export("merakiNetworksEventsExample", example.item)
package main
import (
	"github.com/pulumi/pulumi-meraki/sdk/go/meraki/networks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := networks.GetEvents(ctx, &networks.GetEventsArgs{
			ClientIp:     pulumi.StringRef("string"),
			ClientMac:    pulumi.StringRef("string"),
			ClientName:   pulumi.StringRef("string"),
			DeviceMac:    pulumi.StringRef("string"),
			DeviceName:   pulumi.StringRef("string"),
			DeviceSerial: pulumi.StringRef("string"),
			EndingBefore: pulumi.StringRef("string"),
			ExcludedEventTypes: []string{
				"string",
			},
			IncludedEventTypes: []string{
				"string",
			},
			NetworkId:     "string",
			PerPage:       pulumi.IntRef(1),
			ProductType:   pulumi.StringRef("string"),
			SmDeviceMac:   pulumi.StringRef("string"),
			SmDeviceName:  pulumi.StringRef("string"),
			StartingAfter: pulumi.StringRef("string"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("merakiNetworksEventsExample", example.Item)
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Meraki = Pulumi.Meraki;
return await Deployment.RunAsync(() => 
{
    var example = Meraki.Networks.GetEvents.Invoke(new()
    {
        ClientIp = "string",
        ClientMac = "string",
        ClientName = "string",
        DeviceMac = "string",
        DeviceName = "string",
        DeviceSerial = "string",
        EndingBefore = "string",
        ExcludedEventTypes = new[]
        {
            "string",
        },
        IncludedEventTypes = new[]
        {
            "string",
        },
        NetworkId = "string",
        PerPage = 1,
        ProductType = "string",
        SmDeviceMac = "string",
        SmDeviceName = "string",
        StartingAfter = "string",
    });
    return new Dictionary<string, object?>
    {
        ["merakiNetworksEventsExample"] = example.Apply(getEventsResult => getEventsResult.Item),
    };
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.meraki.networks.NetworksFunctions;
import com.pulumi.meraki.networks.inputs.GetEventsArgs;
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 = NetworksFunctions.getEvents(GetEventsArgs.builder()
            .clientIp("string")
            .clientMac("string")
            .clientName("string")
            .deviceMac("string")
            .deviceName("string")
            .deviceSerial("string")
            .endingBefore("string")
            .excludedEventTypes("string")
            .includedEventTypes("string")
            .networkId("string")
            .perPage(1)
            .productType("string")
            .smDeviceMac("string")
            .smDeviceName("string")
            .startingAfter("string")
            .build());
        ctx.export("merakiNetworksEventsExample", example.applyValue(getEventsResult -> getEventsResult.item()));
    }
}
variables:
  example:
    fn::invoke:
      function: meraki:networks:getEvents
      arguments:
        clientIp: string
        clientMac: string
        clientName: string
        deviceMac: string
        deviceName: string
        deviceSerial: string
        endingBefore: string
        excludedEventTypes:
          - string
        includedEventTypes:
          - string
        networkId: string
        perPage: 1
        productType: string
        smDeviceMac: string
        smDeviceName: string
        startingAfter: string
outputs:
  merakiNetworksEventsExample: ${example.item}
Using getEvents
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 getEvents(args: GetEventsArgs, opts?: InvokeOptions): Promise<GetEventsResult>
function getEventsOutput(args: GetEventsOutputArgs, opts?: InvokeOptions): Output<GetEventsResult>def get_events(client_ip: Optional[str] = None,
               client_mac: Optional[str] = None,
               client_name: Optional[str] = None,
               device_mac: Optional[str] = None,
               device_name: Optional[str] = None,
               device_serial: Optional[str] = None,
               ending_before: Optional[str] = None,
               excluded_event_types: Optional[Sequence[str]] = None,
               included_event_types: Optional[Sequence[str]] = None,
               network_id: Optional[str] = None,
               per_page: Optional[int] = None,
               product_type: Optional[str] = None,
               sm_device_mac: Optional[str] = None,
               sm_device_name: Optional[str] = None,
               starting_after: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetEventsResult
def get_events_output(client_ip: Optional[pulumi.Input[str]] = None,
               client_mac: Optional[pulumi.Input[str]] = None,
               client_name: Optional[pulumi.Input[str]] = None,
               device_mac: Optional[pulumi.Input[str]] = None,
               device_name: Optional[pulumi.Input[str]] = None,
               device_serial: Optional[pulumi.Input[str]] = None,
               ending_before: Optional[pulumi.Input[str]] = None,
               excluded_event_types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
               included_event_types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
               network_id: Optional[pulumi.Input[str]] = None,
               per_page: Optional[pulumi.Input[int]] = None,
               product_type: Optional[pulumi.Input[str]] = None,
               sm_device_mac: Optional[pulumi.Input[str]] = None,
               sm_device_name: Optional[pulumi.Input[str]] = None,
               starting_after: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetEventsResult]func GetEvents(ctx *Context, args *GetEventsArgs, opts ...InvokeOption) (*GetEventsResult, error)
func GetEventsOutput(ctx *Context, args *GetEventsOutputArgs, opts ...InvokeOption) GetEventsResultOutput> Note: This function is named GetEvents in the Go SDK.
public static class GetEvents 
{
    public static Task<GetEventsResult> InvokeAsync(GetEventsArgs args, InvokeOptions? opts = null)
    public static Output<GetEventsResult> Invoke(GetEventsInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetEventsResult> getEvents(GetEventsArgs args, InvokeOptions options)
public static Output<GetEventsResult> getEvents(GetEventsArgs args, InvokeOptions options)
fn::invoke:
  function: meraki:networks/getEvents:getEvents
  arguments:
    # arguments dictionaryThe following arguments are supported:
- NetworkId string
- networkId path parameter. Network ID
- ClientIp string
- clientIp query parameter. The IP of the client which the list of events will be filtered with. Only supported for track-by-IP networks.
- ClientMac string
- clientMac query parameter. The MAC address of the client which the list of events will be filtered with. Only supported for track-by-MAC networks.
- ClientName string
- clientName query parameter. The name, or partial name, of the client which the list of events will be filtered with
- DeviceMac string
- deviceMac query parameter. The MAC address of the Meraki device which the list of events will be filtered with
- DeviceName string
- deviceName query parameter. The name of the Meraki device which the list of events will be filtered with
- DeviceSerial string
- deviceSerial query parameter. The serial of the Meraki device which the list of events will be filtered with
- 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.
- ExcludedEvent List<string>Types 
- excludedEventTypes query parameter. A list of event types. The returned events will be filtered to exclude events with these types.
- IncludedEvent List<string>Types 
- includedEventTypes query parameter. A list of event types. The returned events will be filtered to only include events with these types.
- PerPage int
- perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 10.
- ProductType string
- productType query parameter. The product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, camera, and cellularGateway
- SmDevice stringMac 
- smDeviceMac query parameter. The MAC address of the Systems Manager device which the list of events will be filtered with
- SmDevice stringName 
- smDeviceName query parameter. The name of the Systems Manager device which the list of events will be filtered with
- 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.
- NetworkId string
- networkId path parameter. Network ID
- ClientIp string
- clientIp query parameter. The IP of the client which the list of events will be filtered with. Only supported for track-by-IP networks.
- ClientMac string
- clientMac query parameter. The MAC address of the client which the list of events will be filtered with. Only supported for track-by-MAC networks.
- ClientName string
- clientName query parameter. The name, or partial name, of the client which the list of events will be filtered with
- DeviceMac string
- deviceMac query parameter. The MAC address of the Meraki device which the list of events will be filtered with
- DeviceName string
- deviceName query parameter. The name of the Meraki device which the list of events will be filtered with
- DeviceSerial string
- deviceSerial query parameter. The serial of the Meraki device which the list of events will be filtered with
- 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.
- ExcludedEvent []stringTypes 
- excludedEventTypes query parameter. A list of event types. The returned events will be filtered to exclude events with these types.
- IncludedEvent []stringTypes 
- includedEventTypes query parameter. A list of event types. The returned events will be filtered to only include events with these types.
- PerPage int
- perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 10.
- ProductType string
- productType query parameter. The product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, camera, and cellularGateway
- SmDevice stringMac 
- smDeviceMac query parameter. The MAC address of the Systems Manager device which the list of events will be filtered with
- SmDevice stringName 
- smDeviceName query parameter. The name of the Systems Manager device which the list of events will be filtered with
- 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.
- networkId String
- networkId path parameter. Network ID
- clientIp String
- clientIp query parameter. The IP of the client which the list of events will be filtered with. Only supported for track-by-IP networks.
- clientMac String
- clientMac query parameter. The MAC address of the client which the list of events will be filtered with. Only supported for track-by-MAC networks.
- clientName String
- clientName query parameter. The name, or partial name, of the client which the list of events will be filtered with
- deviceMac String
- deviceMac query parameter. The MAC address of the Meraki device which the list of events will be filtered with
- deviceName String
- deviceName query parameter. The name of the Meraki device which the list of events will be filtered with
- deviceSerial String
- deviceSerial query parameter. The serial of the Meraki device which the list of events will be filtered with
- 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.
- excludedEvent List<String>Types 
- excludedEventTypes query parameter. A list of event types. The returned events will be filtered to exclude events with these types.
- includedEvent List<String>Types 
- includedEventTypes query parameter. A list of event types. The returned events will be filtered to only include events with these types.
- perPage Integer
- perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 10.
- productType String
- productType query parameter. The product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, camera, and cellularGateway
- smDevice StringMac 
- smDeviceMac query parameter. The MAC address of the Systems Manager device which the list of events will be filtered with
- smDevice StringName 
- smDeviceName query parameter. The name of the Systems Manager device which the list of events will be filtered with
- 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.
- networkId string
- networkId path parameter. Network ID
- clientIp string
- clientIp query parameter. The IP of the client which the list of events will be filtered with. Only supported for track-by-IP networks.
- clientMac string
- clientMac query parameter. The MAC address of the client which the list of events will be filtered with. Only supported for track-by-MAC networks.
- clientName string
- clientName query parameter. The name, or partial name, of the client which the list of events will be filtered with
- deviceMac string
- deviceMac query parameter. The MAC address of the Meraki device which the list of events will be filtered with
- deviceName string
- deviceName query parameter. The name of the Meraki device which the list of events will be filtered with
- deviceSerial string
- deviceSerial query parameter. The serial of the Meraki device which the list of events will be filtered with
- 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.
- excludedEvent string[]Types 
- excludedEventTypes query parameter. A list of event types. The returned events will be filtered to exclude events with these types.
- includedEvent string[]Types 
- includedEventTypes query parameter. A list of event types. The returned events will be filtered to only include events with these types.
- perPage number
- perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 10.
- productType string
- productType query parameter. The product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, camera, and cellularGateway
- smDevice stringMac 
- smDeviceMac query parameter. The MAC address of the Systems Manager device which the list of events will be filtered with
- smDevice stringName 
- smDeviceName query parameter. The name of the Systems Manager device which the list of events will be filtered with
- 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.
- network_id str
- networkId path parameter. Network ID
- client_ip str
- clientIp query parameter. The IP of the client which the list of events will be filtered with. Only supported for track-by-IP networks.
- client_mac str
- clientMac query parameter. The MAC address of the client which the list of events will be filtered with. Only supported for track-by-MAC networks.
- client_name str
- clientName query parameter. The name, or partial name, of the client which the list of events will be filtered with
- device_mac str
- deviceMac query parameter. The MAC address of the Meraki device which the list of events will be filtered with
- device_name str
- deviceName query parameter. The name of the Meraki device which the list of events will be filtered with
- device_serial str
- deviceSerial query parameter. The serial of the Meraki device which the list of events will be filtered with
- 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.
- excluded_event_ Sequence[str]types 
- excludedEventTypes query parameter. A list of event types. The returned events will be filtered to exclude events with these types.
- included_event_ Sequence[str]types 
- includedEventTypes query parameter. A list of event types. The returned events will be filtered to only include events with these types.
- per_page int
- perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 10.
- product_type str
- productType query parameter. The product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, camera, and cellularGateway
- sm_device_ strmac 
- smDeviceMac query parameter. The MAC address of the Systems Manager device which the list of events will be filtered with
- sm_device_ strname 
- smDeviceName query parameter. The name of the Systems Manager device which the list of events will be filtered with
- 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.
- networkId String
- networkId path parameter. Network ID
- clientIp String
- clientIp query parameter. The IP of the client which the list of events will be filtered with. Only supported for track-by-IP networks.
- clientMac String
- clientMac query parameter. The MAC address of the client which the list of events will be filtered with. Only supported for track-by-MAC networks.
- clientName String
- clientName query parameter. The name, or partial name, of the client which the list of events will be filtered with
- deviceMac String
- deviceMac query parameter. The MAC address of the Meraki device which the list of events will be filtered with
- deviceName String
- deviceName query parameter. The name of the Meraki device which the list of events will be filtered with
- deviceSerial String
- deviceSerial query parameter. The serial of the Meraki device which the list of events will be filtered with
- 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.
- excludedEvent List<String>Types 
- excludedEventTypes query parameter. A list of event types. The returned events will be filtered to exclude events with these types.
- includedEvent List<String>Types 
- includedEventTypes query parameter. A list of event types. The returned events will be filtered to only include events with these types.
- perPage Number
- perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 10.
- productType String
- productType query parameter. The product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, camera, and cellularGateway
- smDevice StringMac 
- smDeviceMac query parameter. The MAC address of the Systems Manager device which the list of events will be filtered with
- smDevice StringName 
- smDeviceName query parameter. The name of the Systems Manager device which the list of events will be filtered with
- 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.
getEvents Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Item
GetEvents Item 
- NetworkId string
- networkId path parameter. Network ID
- ClientIp string
- clientIp query parameter. The IP of the client which the list of events will be filtered with. Only supported for track-by-IP networks.
- ClientMac string
- clientMac query parameter. The MAC address of the client which the list of events will be filtered with. Only supported for track-by-MAC networks.
- ClientName string
- clientName query parameter. The name, or partial name, of the client which the list of events will be filtered with
- DeviceMac string
- deviceMac query parameter. The MAC address of the Meraki device which the list of events will be filtered with
- DeviceName string
- deviceName query parameter. The name of the Meraki device which the list of events will be filtered with
- DeviceSerial string
- deviceSerial query parameter. The serial of the Meraki device which the list of events will be filtered with
- 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.
- ExcludedEvent List<string>Types 
- excludedEventTypes query parameter. A list of event types. The returned events will be filtered to exclude events with these types.
- IncludedEvent List<string>Types 
- includedEventTypes query parameter. A list of event types. The returned events will be filtered to only include events with these types.
- PerPage int
- perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 10.
- ProductType string
- productType query parameter. The product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, camera, and cellularGateway
- SmDevice stringMac 
- smDeviceMac query parameter. The MAC address of the Systems Manager device which the list of events will be filtered with
- SmDevice stringName 
- smDeviceName query parameter. The name of the Systems Manager device which the list of events will be filtered with
- 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.
- Item
GetEvents Item 
- NetworkId string
- networkId path parameter. Network ID
- ClientIp string
- clientIp query parameter. The IP of the client which the list of events will be filtered with. Only supported for track-by-IP networks.
- ClientMac string
- clientMac query parameter. The MAC address of the client which the list of events will be filtered with. Only supported for track-by-MAC networks.
- ClientName string
- clientName query parameter. The name, or partial name, of the client which the list of events will be filtered with
- DeviceMac string
- deviceMac query parameter. The MAC address of the Meraki device which the list of events will be filtered with
- DeviceName string
- deviceName query parameter. The name of the Meraki device which the list of events will be filtered with
- DeviceSerial string
- deviceSerial query parameter. The serial of the Meraki device which the list of events will be filtered with
- 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.
- ExcludedEvent []stringTypes 
- excludedEventTypes query parameter. A list of event types. The returned events will be filtered to exclude events with these types.
- IncludedEvent []stringTypes 
- includedEventTypes query parameter. A list of event types. The returned events will be filtered to only include events with these types.
- PerPage int
- perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 10.
- ProductType string
- productType query parameter. The product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, camera, and cellularGateway
- SmDevice stringMac 
- smDeviceMac query parameter. The MAC address of the Systems Manager device which the list of events will be filtered with
- SmDevice stringName 
- smDeviceName query parameter. The name of the Systems Manager device which the list of events will be filtered with
- 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.
- item
GetEvents Item 
- networkId String
- networkId path parameter. Network ID
- clientIp String
- clientIp query parameter. The IP of the client which the list of events will be filtered with. Only supported for track-by-IP networks.
- clientMac String
- clientMac query parameter. The MAC address of the client which the list of events will be filtered with. Only supported for track-by-MAC networks.
- clientName String
- clientName query parameter. The name, or partial name, of the client which the list of events will be filtered with
- deviceMac String
- deviceMac query parameter. The MAC address of the Meraki device which the list of events will be filtered with
- deviceName String
- deviceName query parameter. The name of the Meraki device which the list of events will be filtered with
- deviceSerial String
- deviceSerial query parameter. The serial of the Meraki device which the list of events will be filtered with
- 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.
- excludedEvent List<String>Types 
- excludedEventTypes query parameter. A list of event types. The returned events will be filtered to exclude events with these types.
- includedEvent List<String>Types 
- includedEventTypes query parameter. A list of event types. The returned events will be filtered to only include events with these types.
- perPage Integer
- perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 10.
- productType String
- productType query parameter. The product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, camera, and cellularGateway
- smDevice StringMac 
- smDeviceMac query parameter. The MAC address of the Systems Manager device which the list of events will be filtered with
- smDevice StringName 
- smDeviceName query parameter. The name of the Systems Manager device which the list of events will be filtered with
- 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.
- item
GetEvents Item 
- networkId string
- networkId path parameter. Network ID
- clientIp string
- clientIp query parameter. The IP of the client which the list of events will be filtered with. Only supported for track-by-IP networks.
- clientMac string
- clientMac query parameter. The MAC address of the client which the list of events will be filtered with. Only supported for track-by-MAC networks.
- clientName string
- clientName query parameter. The name, or partial name, of the client which the list of events will be filtered with
- deviceMac string
- deviceMac query parameter. The MAC address of the Meraki device which the list of events will be filtered with
- deviceName string
- deviceName query parameter. The name of the Meraki device which the list of events will be filtered with
- deviceSerial string
- deviceSerial query parameter. The serial of the Meraki device which the list of events will be filtered with
- 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.
- excludedEvent string[]Types 
- excludedEventTypes query parameter. A list of event types. The returned events will be filtered to exclude events with these types.
- includedEvent string[]Types 
- includedEventTypes query parameter. A list of event types. The returned events will be filtered to only include events with these types.
- perPage number
- perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 10.
- productType string
- productType query parameter. The product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, camera, and cellularGateway
- smDevice stringMac 
- smDeviceMac query parameter. The MAC address of the Systems Manager device which the list of events will be filtered with
- smDevice stringName 
- smDeviceName query parameter. The name of the Systems Manager device which the list of events will be filtered with
- 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.
- item
GetEvents Item 
- network_id str
- networkId path parameter. Network ID
- client_ip str
- clientIp query parameter. The IP of the client which the list of events will be filtered with. Only supported for track-by-IP networks.
- client_mac str
- clientMac query parameter. The MAC address of the client which the list of events will be filtered with. Only supported for track-by-MAC networks.
- client_name str
- clientName query parameter. The name, or partial name, of the client which the list of events will be filtered with
- device_mac str
- deviceMac query parameter. The MAC address of the Meraki device which the list of events will be filtered with
- device_name str
- deviceName query parameter. The name of the Meraki device which the list of events will be filtered with
- device_serial str
- deviceSerial query parameter. The serial of the Meraki device which the list of events will be filtered with
- 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.
- excluded_event_ Sequence[str]types 
- excludedEventTypes query parameter. A list of event types. The returned events will be filtered to exclude events with these types.
- included_event_ Sequence[str]types 
- includedEventTypes query parameter. A list of event types. The returned events will be filtered to only include events with these types.
- per_page int
- perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 10.
- product_type str
- productType query parameter. The product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, camera, and cellularGateway
- sm_device_ strmac 
- smDeviceMac query parameter. The MAC address of the Systems Manager device which the list of events will be filtered with
- sm_device_ strname 
- smDeviceName query parameter. The name of the Systems Manager device which the list of events will be filtered with
- 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.
- item Property Map
- networkId String
- networkId path parameter. Network ID
- clientIp String
- clientIp query parameter. The IP of the client which the list of events will be filtered with. Only supported for track-by-IP networks.
- clientMac String
- clientMac query parameter. The MAC address of the client which the list of events will be filtered with. Only supported for track-by-MAC networks.
- clientName String
- clientName query parameter. The name, or partial name, of the client which the list of events will be filtered with
- deviceMac String
- deviceMac query parameter. The MAC address of the Meraki device which the list of events will be filtered with
- deviceName String
- deviceName query parameter. The name of the Meraki device which the list of events will be filtered with
- deviceSerial String
- deviceSerial query parameter. The serial of the Meraki device which the list of events will be filtered with
- 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.
- excludedEvent List<String>Types 
- excludedEventTypes query parameter. A list of event types. The returned events will be filtered to exclude events with these types.
- includedEvent List<String>Types 
- includedEventTypes query parameter. A list of event types. The returned events will be filtered to only include events with these types.
- perPage Number
- perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 10.
- productType String
- productType query parameter. The product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, camera, and cellularGateway
- smDevice StringMac 
- smDeviceMac query parameter. The MAC address of the Systems Manager device which the list of events will be filtered with
- smDevice StringName 
- smDeviceName query parameter. The name of the Systems Manager device which the list of events will be filtered with
- 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
GetEventsItem  
- Events
List<GetEvents Item Event> 
- An array of events that took place in the network.
- Message string
- A message regarding the events sent. Usually 'null' unless there are no events
- PageEnd stringAt 
- An UTC ISO8601 string of the latest occured at time of the listed events of the page.
- PageStart stringAt 
- An UTC ISO8601 string of the earliest occured at time of the listed events of the page.
- Events
[]GetEvents Item Event 
- An array of events that took place in the network.
- Message string
- A message regarding the events sent. Usually 'null' unless there are no events
- PageEnd stringAt 
- An UTC ISO8601 string of the latest occured at time of the listed events of the page.
- PageStart stringAt 
- An UTC ISO8601 string of the earliest occured at time of the listed events of the page.
- events
List<GetEvents Item Event> 
- An array of events that took place in the network.
- message String
- A message regarding the events sent. Usually 'null' unless there are no events
- pageEnd StringAt 
- An UTC ISO8601 string of the latest occured at time of the listed events of the page.
- pageStart StringAt 
- An UTC ISO8601 string of the earliest occured at time of the listed events of the page.
- events
GetEvents Item Event[] 
- An array of events that took place in the network.
- message string
- A message regarding the events sent. Usually 'null' unless there are no events
- pageEnd stringAt 
- An UTC ISO8601 string of the latest occured at time of the listed events of the page.
- pageStart stringAt 
- An UTC ISO8601 string of the earliest occured at time of the listed events of the page.
- events
Sequence[GetEvents Item Event] 
- An array of events that took place in the network.
- message str
- A message regarding the events sent. Usually 'null' unless there are no events
- page_end_ strat 
- An UTC ISO8601 string of the latest occured at time of the listed events of the page.
- page_start_ strat 
- An UTC ISO8601 string of the earliest occured at time of the listed events of the page.
- events List<Property Map>
- An array of events that took place in the network.
- message String
- A message regarding the events sent. Usually 'null' unless there are no events
- pageEnd StringAt 
- An UTC ISO8601 string of the latest occured at time of the listed events of the page.
- pageStart StringAt 
- An UTC ISO8601 string of the earliest occured at time of the listed events of the page.
GetEventsItemEvent   
- Category string
- The category that the event type belongs to
- ClientDescription string
- A description of the client. This is usually the client's device name.
- ClientId string
- A string identifying the client. This could be a client's MAC or IP address
- ClientMac string
- The client's MAC address.
- Description string
- A description of the event the happened.
- DeviceName string
- The name of the device. Only shown if the device is an access point.
- DeviceSerial string
- The serial number of the device. Only shown if the device is an access point.
- EventData GetEvents Item Event Event Data 
- An object containing more data related to the event.
- NetworkId string
- The ID of the network.
- OccurredAt string
- An UTC ISO8601 string of the time the event occurred at.
- SsidNumber int
- The SSID number of the device.
- Type string
- The type of event being listed.
- Category string
- The category that the event type belongs to
- ClientDescription string
- A description of the client. This is usually the client's device name.
- ClientId string
- A string identifying the client. This could be a client's MAC or IP address
- ClientMac string
- The client's MAC address.
- Description string
- A description of the event the happened.
- DeviceName string
- The name of the device. Only shown if the device is an access point.
- DeviceSerial string
- The serial number of the device. Only shown if the device is an access point.
- EventData GetEvents Item Event Event Data 
- An object containing more data related to the event.
- NetworkId string
- The ID of the network.
- OccurredAt string
- An UTC ISO8601 string of the time the event occurred at.
- SsidNumber int
- The SSID number of the device.
- Type string
- The type of event being listed.
- category String
- The category that the event type belongs to
- clientDescription String
- A description of the client. This is usually the client's device name.
- clientId String
- A string identifying the client. This could be a client's MAC or IP address
- clientMac String
- The client's MAC address.
- description String
- A description of the event the happened.
- deviceName String
- The name of the device. Only shown if the device is an access point.
- deviceSerial String
- The serial number of the device. Only shown if the device is an access point.
- eventData GetEvents Item Event Event Data 
- An object containing more data related to the event.
- networkId String
- The ID of the network.
- occurredAt String
- An UTC ISO8601 string of the time the event occurred at.
- ssidNumber Integer
- The SSID number of the device.
- type String
- The type of event being listed.
- category string
- The category that the event type belongs to
- clientDescription string
- A description of the client. This is usually the client's device name.
- clientId string
- A string identifying the client. This could be a client's MAC or IP address
- clientMac string
- The client's MAC address.
- description string
- A description of the event the happened.
- deviceName string
- The name of the device. Only shown if the device is an access point.
- deviceSerial string
- The serial number of the device. Only shown if the device is an access point.
- eventData GetEvents Item Event Event Data 
- An object containing more data related to the event.
- networkId string
- The ID of the network.
- occurredAt string
- An UTC ISO8601 string of the time the event occurred at.
- ssidNumber number
- The SSID number of the device.
- type string
- The type of event being listed.
- category str
- The category that the event type belongs to
- client_description str
- A description of the client. This is usually the client's device name.
- client_id str
- A string identifying the client. This could be a client's MAC or IP address
- client_mac str
- The client's MAC address.
- description str
- A description of the event the happened.
- device_name str
- The name of the device. Only shown if the device is an access point.
- device_serial str
- The serial number of the device. Only shown if the device is an access point.
- event_data GetEvents Item Event Event Data 
- An object containing more data related to the event.
- network_id str
- The ID of the network.
- occurred_at str
- An UTC ISO8601 string of the time the event occurred at.
- ssid_number int
- The SSID number of the device.
- type str
- The type of event being listed.
- category String
- The category that the event type belongs to
- clientDescription String
- A description of the client. This is usually the client's device name.
- clientId String
- A string identifying the client. This could be a client's MAC or IP address
- clientMac String
- The client's MAC address.
- description String
- A description of the event the happened.
- deviceName String
- The name of the device. Only shown if the device is an access point.
- deviceSerial String
- The serial number of the device. Only shown if the device is an access point.
- eventData Property Map
- An object containing more data related to the event.
- networkId String
- The ID of the network.
- occurredAt String
- An UTC ISO8601 string of the time the event occurred at.
- ssidNumber Number
- The SSID number of the device.
- type String
- The type of event being listed.
GetEventsItemEventEventData     
- Aid string
- The association ID of the client.
- Channel string
- The radio channel the client is connecting to.
- ClientIp string
- The client's IP address
- ClientMac string
- The client's MAC address
- Radio string
- The radio band number the client is trying to connect to.
- Rssi string
- The current received signal strength indication (RSSI) of the client connected to an AP.
- Vap string
- The virtual access point (VAP) number the client is connecting to.
- Aid string
- The association ID of the client.
- Channel string
- The radio channel the client is connecting to.
- ClientIp string
- The client's IP address
- ClientMac string
- The client's MAC address
- Radio string
- The radio band number the client is trying to connect to.
- Rssi string
- The current received signal strength indication (RSSI) of the client connected to an AP.
- Vap string
- The virtual access point (VAP) number the client is connecting to.
- aid String
- The association ID of the client.
- channel String
- The radio channel the client is connecting to.
- clientIp String
- The client's IP address
- clientMac String
- The client's MAC address
- radio String
- The radio band number the client is trying to connect to.
- rssi String
- The current received signal strength indication (RSSI) of the client connected to an AP.
- vap String
- The virtual access point (VAP) number the client is connecting to.
- aid string
- The association ID of the client.
- channel string
- The radio channel the client is connecting to.
- clientIp string
- The client's IP address
- clientMac string
- The client's MAC address
- radio string
- The radio band number the client is trying to connect to.
- rssi string
- The current received signal strength indication (RSSI) of the client connected to an AP.
- vap string
- The virtual access point (VAP) number the client is connecting to.
- aid str
- The association ID of the client.
- channel str
- The radio channel the client is connecting to.
- client_ip str
- The client's IP address
- client_mac str
- The client's MAC address
- radio str
- The radio band number the client is trying to connect to.
- rssi str
- The current received signal strength indication (RSSI) of the client connected to an AP.
- vap str
- The virtual access point (VAP) number the client is connecting to.
- aid String
- The association ID of the client.
- channel String
- The radio channel the client is connecting to.
- clientIp String
- The client's IP address
- clientMac String
- The client's MAC address
- radio String
- The radio band number the client is trying to connect to.
- rssi String
- The current received signal strength indication (RSSI) of the client connected to an AP.
- vap String
- The virtual access point (VAP) number the client is connecting to.
Package Details
- Repository
- meraki pulumi/pulumi-meraki
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the merakiTerraform Provider.
