Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: meraki:networks/getEvents:getEvents
arguments:
# arguments dictionary
The following arguments are supported:
- Network
Id string - networkId path parameter. Network ID
- Client
Ip 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.
- Client
Mac 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.
- Client
Name string - clientName query parameter. The name, or partial name, of the client which the list of events will be filtered with
- Device
Mac string - deviceMac query parameter. The MAC address of the Meraki device which the list of events will be filtered with
- Device
Name string - deviceName query parameter. The name of the Meraki device which the list of events will be filtered with
- Device
Serial string - deviceSerial query parameter. The serial of the Meraki device which the list of events will be filtered with
- Ending
Before 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.
- Excluded
Event List<string>Types - excludedEventTypes query parameter. A list of event types. The returned events will be filtered to exclude events with these types.
- Included
Event List<string>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 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
- Sm
Device stringMac - smDeviceMac query parameter. The MAC address of the Systems Manager device which the list of events will be filtered with
- Sm
Device stringName - smDeviceName query parameter. The name of the Systems Manager device which the list of events will be filtered with
- Starting
After 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 string - networkId path parameter. Network ID
- Client
Ip 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.
- Client
Mac 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.
- Client
Name string - clientName query parameter. The name, or partial name, of the client which the list of events will be filtered with
- Device
Mac string - deviceMac query parameter. The MAC address of the Meraki device which the list of events will be filtered with
- Device
Name string - deviceName query parameter. The name of the Meraki device which the list of events will be filtered with
- Device
Serial string - deviceSerial query parameter. The serial of the Meraki device which the list of events will be filtered with
- Ending
Before 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.
- Excluded
Event []stringTypes - excludedEventTypes query parameter. A list of event types. The returned events will be filtered to exclude events with these types.
- Included
Event []stringTypes - 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 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
- Sm
Device stringMac - smDeviceMac query parameter. The MAC address of the Systems Manager device which the list of events will be filtered with
- Sm
Device stringName - smDeviceName query parameter. The name of the Systems Manager device which the list of events will be filtered with
- Starting
After 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 String - networkId path parameter. Network ID
- client
Ip 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.
- client
Mac 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.
- client
Name String - clientName query parameter. The name, or partial name, of the client which the list of events will be filtered with
- device
Mac String - deviceMac query parameter. The MAC address of the Meraki device which the list of events will be filtered with
- device
Name String - deviceName query parameter. The name of the Meraki device which the list of events will be filtered with
- device
Serial String - deviceSerial query parameter. The serial of the Meraki device which the list of events will be filtered with
- ending
Before 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.
- excluded
Event List<String>Types - excludedEventTypes query parameter. A list of event types. The returned events will be filtered to exclude events with these types.
- included
Event List<String>Types - includedEventTypes query parameter. A list of event types. The returned events will be filtered to only include events with these types.
- per
Page Integer - perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 10.
- product
Type 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
- sm
Device StringMac - smDeviceMac query parameter. The MAC address of the Systems Manager device which the list of events will be filtered with
- sm
Device StringName - smDeviceName query parameter. The name of the Systems Manager device which the list of events will be filtered with
- starting
After 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 string - networkId path parameter. Network ID
- client
Ip 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.
- client
Mac 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.
- client
Name string - clientName query parameter. The name, or partial name, of the client which the list of events will be filtered with
- device
Mac string - deviceMac query parameter. The MAC address of the Meraki device which the list of events will be filtered with
- device
Name string - deviceName query parameter. The name of the Meraki device which the list of events will be filtered with
- device
Serial string - deviceSerial query parameter. The serial of the Meraki device which the list of events will be filtered with
- ending
Before 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.
- excluded
Event string[]Types - excludedEventTypes query parameter. A list of event types. The returned events will be filtered to exclude events with these types.
- included
Event string[]Types - includedEventTypes query parameter. A list of event types. The returned events will be filtered to only include events with these types.
- per
Page number - perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 10.
- product
Type 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
- sm
Device stringMac - smDeviceMac query parameter. The MAC address of the Systems Manager device which the list of events will be filtered with
- sm
Device stringName - smDeviceName query parameter. The name of the Systems Manager device which the list of events will be filtered with
- starting
After 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.
- network
Id String - networkId path parameter. Network ID
- client
Ip 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.
- client
Mac 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.
- client
Name String - clientName query parameter. The name, or partial name, of the client which the list of events will be filtered with
- device
Mac String - deviceMac query parameter. The MAC address of the Meraki device which the list of events will be filtered with
- device
Name String - deviceName query parameter. The name of the Meraki device which the list of events will be filtered with
- device
Serial String - deviceSerial query parameter. The serial of the Meraki device which the list of events will be filtered with
- ending
Before 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.
- excluded
Event List<String>Types - excludedEventTypes query parameter. A list of event types. The returned events will be filtered to exclude events with these types.
- included
Event List<String>Types - includedEventTypes query parameter. A list of event types. The returned events will be filtered to only include events with these types.
- per
Page Number - perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 10.
- product
Type 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
- sm
Device StringMac - smDeviceMac query parameter. The MAC address of the Systems Manager device which the list of events will be filtered with
- sm
Device StringName - smDeviceName query parameter. The name of the Systems Manager device which the list of events will be filtered with
- starting
After 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
Get
Events Item - Network
Id string - networkId path parameter. Network ID
- Client
Ip 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.
- Client
Mac 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.
- Client
Name string - clientName query parameter. The name, or partial name, of the client which the list of events will be filtered with
- Device
Mac string - deviceMac query parameter. The MAC address of the Meraki device which the list of events will be filtered with
- Device
Name string - deviceName query parameter. The name of the Meraki device which the list of events will be filtered with
- Device
Serial string - deviceSerial query parameter. The serial of the Meraki device which the list of events will be filtered with
- Ending
Before 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.
- Excluded
Event List<string>Types - excludedEventTypes query parameter. A list of event types. The returned events will be filtered to exclude events with these types.
- Included
Event List<string>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 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
- Sm
Device stringMac - smDeviceMac query parameter. The MAC address of the Systems Manager device which the list of events will be filtered with
- Sm
Device stringName - smDeviceName query parameter. The name of the Systems Manager device which the list of events will be filtered with
- Starting
After 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
Get
Events Item - Network
Id string - networkId path parameter. Network ID
- Client
Ip 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.
- Client
Mac 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.
- Client
Name string - clientName query parameter. The name, or partial name, of the client which the list of events will be filtered with
- Device
Mac string - deviceMac query parameter. The MAC address of the Meraki device which the list of events will be filtered with
- Device
Name string - deviceName query parameter. The name of the Meraki device which the list of events will be filtered with
- Device
Serial string - deviceSerial query parameter. The serial of the Meraki device which the list of events will be filtered with
- Ending
Before 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.
- Excluded
Event []stringTypes - excludedEventTypes query parameter. A list of event types. The returned events will be filtered to exclude events with these types.
- Included
Event []stringTypes - 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 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
- Sm
Device stringMac - smDeviceMac query parameter. The MAC address of the Systems Manager device which the list of events will be filtered with
- Sm
Device stringName - smDeviceName query parameter. The name of the Systems Manager device which the list of events will be filtered with
- Starting
After 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
Get
Events Item - network
Id String - networkId path parameter. Network ID
- client
Ip 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.
- client
Mac 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.
- client
Name String - clientName query parameter. The name, or partial name, of the client which the list of events will be filtered with
- device
Mac String - deviceMac query parameter. The MAC address of the Meraki device which the list of events will be filtered with
- device
Name String - deviceName query parameter. The name of the Meraki device which the list of events will be filtered with
- device
Serial String - deviceSerial query parameter. The serial of the Meraki device which the list of events will be filtered with
- ending
Before 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.
- excluded
Event List<String>Types - excludedEventTypes query parameter. A list of event types. The returned events will be filtered to exclude events with these types.
- included
Event List<String>Types - includedEventTypes query parameter. A list of event types. The returned events will be filtered to only include events with these types.
- per
Page Integer - perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 10.
- product
Type 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
- sm
Device StringMac - smDeviceMac query parameter. The MAC address of the Systems Manager device which the list of events will be filtered with
- sm
Device StringName - smDeviceName query parameter. The name of the Systems Manager device which the list of events will be filtered with
- starting
After 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
Get
Events Item - network
Id string - networkId path parameter. Network ID
- client
Ip 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.
- client
Mac 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.
- client
Name string - clientName query parameter. The name, or partial name, of the client which the list of events will be filtered with
- device
Mac string - deviceMac query parameter. The MAC address of the Meraki device which the list of events will be filtered with
- device
Name string - deviceName query parameter. The name of the Meraki device which the list of events will be filtered with
- device
Serial string - deviceSerial query parameter. The serial of the Meraki device which the list of events will be filtered with
- ending
Before 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.
- excluded
Event string[]Types - excludedEventTypes query parameter. A list of event types. The returned events will be filtered to exclude events with these types.
- included
Event string[]Types - includedEventTypes query parameter. A list of event types. The returned events will be filtered to only include events with these types.
- per
Page number - perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 10.
- product
Type 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
- sm
Device stringMac - smDeviceMac query parameter. The MAC address of the Systems Manager device which the list of events will be filtered with
- sm
Device stringName - smDeviceName query parameter. The name of the Systems Manager device which the list of events will be filtered with
- starting
After 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
Get
Events 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
- network
Id String - networkId path parameter. Network ID
- client
Ip 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.
- client
Mac 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.
- client
Name String - clientName query parameter. The name, or partial name, of the client which the list of events will be filtered with
- device
Mac String - deviceMac query parameter. The MAC address of the Meraki device which the list of events will be filtered with
- device
Name String - deviceName query parameter. The name of the Meraki device which the list of events will be filtered with
- device
Serial String - deviceSerial query parameter. The serial of the Meraki device which the list of events will be filtered with
- ending
Before 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.
- excluded
Event List<String>Types - excludedEventTypes query parameter. A list of event types. The returned events will be filtered to exclude events with these types.
- included
Event List<String>Types - includedEventTypes query parameter. A list of event types. The returned events will be filtered to only include events with these types.
- per
Page Number - perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 10.
- product
Type 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
- sm
Device StringMac - smDeviceMac query parameter. The MAC address of the Systems Manager device which the list of events will be filtered with
- sm
Device StringName - smDeviceName query parameter. The name of the Systems Manager device which the list of events will be filtered with
- starting
After 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<Get
Events 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
- Page
End stringAt - An UTC ISO8601 string of the latest occured at time of the listed events of the page.
- Page
Start stringAt - An UTC ISO8601 string of the earliest occured at time of the listed events of the page.
- Events
[]Get
Events 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
- Page
End stringAt - An UTC ISO8601 string of the latest occured at time of the listed events of the page.
- Page
Start stringAt - An UTC ISO8601 string of the earliest occured at time of the listed events of the page.
- events
List<Get
Events 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
- page
End StringAt - An UTC ISO8601 string of the latest occured at time of the listed events of the page.
- page
Start StringAt - An UTC ISO8601 string of the earliest occured at time of the listed events of the page.
- events
Get
Events 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
- page
End stringAt - An UTC ISO8601 string of the latest occured at time of the listed events of the page.
- page
Start stringAt - An UTC ISO8601 string of the earliest occured at time of the listed events of the page.
- events
Sequence[Get
Events 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
- page
End StringAt - An UTC ISO8601 string of the latest occured at time of the listed events of the page.
- page
Start 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
- Client
Description string - A description of the client. This is usually the client's device name.
- Client
Id string - A string identifying the client. This could be a client's MAC or IP address
- Client
Mac string - The client's MAC address.
- Description string
- A description of the event the happened.
- Device
Name string - The name of the device. Only shown if the device is an access point.
- Device
Serial string - 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 string - The ID of the network.
- Occurred
At string - An UTC ISO8601 string of the time the event occurred at.
- Ssid
Number 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
- Client
Description string - A description of the client. This is usually the client's device name.
- Client
Id string - A string identifying the client. This could be a client's MAC or IP address
- Client
Mac string - The client's MAC address.
- Description string
- A description of the event the happened.
- Device
Name string - The name of the device. Only shown if the device is an access point.
- Device
Serial string - 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 string - The ID of the network.
- Occurred
At string - An UTC ISO8601 string of the time the event occurred at.
- Ssid
Number 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
- client
Description String - A description of the client. This is usually the client's device name.
- client
Id String - A string identifying the client. This could be a client's MAC or IP address
- client
Mac String - The client's MAC address.
- description String
- A description of the event the happened.
- device
Name String - The name of the device. Only shown if the device is an access point.
- device
Serial String - 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 String - The ID of the network.
- occurred
At String - An UTC ISO8601 string of the time the event occurred at.
- ssid
Number 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
- client
Description string - A description of the client. This is usually the client's device name.
- client
Id string - A string identifying the client. This could be a client's MAC or IP address
- client
Mac string - The client's MAC address.
- description string
- A description of the event the happened.
- device
Name string - The name of the device. Only shown if the device is an access point.
- device
Serial string - 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 string - The ID of the network.
- occurred
At string - An UTC ISO8601 string of the time the event occurred at.
- ssid
Number 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
- client
Description String - A description of the client. This is usually the client's device name.
- client
Id String - A string identifying the client. This could be a client's MAC or IP address
- client
Mac String - The client's MAC address.
- description String
- A description of the event the happened.
- device
Name String - The name of the device. Only shown if the device is an access point.
- device
Serial String - The serial number of the device. Only shown if the device is an access point.
- event
Data Property Map - An object containing more data related to the event.
- network
Id String - The ID of the network.
- occurred
At String - An UTC ISO8601 string of the time the event occurred at.
- ssid
Number 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.
- Client
Ip string - The client's IP address
- Client
Mac 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.
- Client
Ip string - The client's IP address
- Client
Mac 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.
- client
Ip String - The client's IP address
- client
Mac 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.
- client
Ip string - The client's IP address
- client
Mac 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.
- client
Ip String - The client's IP address
- client
Mac 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
meraki
Terraform Provider.