@pulumi/meraki
Version:
A Pulumi package for creating and managing Cisco Meraki resources. Based on terraform-provider-meraki: version v0.2.0
192 lines (191 loc) • 6.21 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as meraki from "@pulumi/meraki";
*
* const example = meraki.networks.getWirelessFailedConnections({
* apTag: "string",
* band: "string",
* clientId: "string",
* networkId: "string",
* serial: "string",
* ssid: 1,
* t0: "string",
* t1: "string",
* timespan: 1,
* vlan: 1,
* });
* export const merakiNetworksWirelessFailedConnectionsExample = example.then(example => example.items);
* ```
*/
export declare function getWirelessFailedConnections(args: GetWirelessFailedConnectionsArgs, opts?: pulumi.InvokeOptions): Promise<GetWirelessFailedConnectionsResult>;
/**
* A collection of arguments for invoking getWirelessFailedConnections.
*/
export interface GetWirelessFailedConnectionsArgs {
/**
* apTag query parameter. Filter results by AP Tag
*/
apTag?: string;
/**
* band query parameter. Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.
*/
band?: string;
/**
* clientId query parameter. Filter by client MAC
*/
clientId?: string;
/**
* networkId path parameter. Network ID
*/
networkId: string;
/**
* serial query parameter. Filter by AP
*/
serial?: string;
/**
* ssid query parameter. Filter results by SSID
*/
ssid?: number;
/**
* t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 180 days from today.
*/
t0?: string;
/**
* t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 7 days after t0.
*/
t1?: string;
/**
* timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days.
*/
timespan?: number;
/**
* vlan query parameter. Filter results by VLAN
*/
vlan?: number;
}
/**
* A collection of values returned by getWirelessFailedConnections.
*/
export interface GetWirelessFailedConnectionsResult {
/**
* apTag query parameter. Filter results by AP Tag
*/
readonly apTag?: string;
/**
* band query parameter. Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.
*/
readonly band?: string;
/**
* clientId query parameter. Filter by client MAC
*/
readonly clientId?: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* Array of ResponseWirelessGetNetworkWirelessFailedConnections
*/
readonly items: outputs.networks.GetWirelessFailedConnectionsItem[];
/**
* networkId path parameter. Network ID
*/
readonly networkId: string;
/**
* serial query parameter. Filter by AP
*/
readonly serial?: string;
/**
* ssid query parameter. Filter results by SSID
*/
readonly ssid?: number;
/**
* t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 180 days from today.
*/
readonly t0?: string;
/**
* t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 7 days after t0.
*/
readonly t1?: string;
/**
* timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days.
*/
readonly timespan?: number;
/**
* vlan query parameter. Filter results by VLAN
*/
readonly vlan?: number;
}
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as meraki from "@pulumi/meraki";
*
* const example = meraki.networks.getWirelessFailedConnections({
* apTag: "string",
* band: "string",
* clientId: "string",
* networkId: "string",
* serial: "string",
* ssid: 1,
* t0: "string",
* t1: "string",
* timespan: 1,
* vlan: 1,
* });
* export const merakiNetworksWirelessFailedConnectionsExample = example.then(example => example.items);
* ```
*/
export declare function getWirelessFailedConnectionsOutput(args: GetWirelessFailedConnectionsOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetWirelessFailedConnectionsResult>;
/**
* A collection of arguments for invoking getWirelessFailedConnections.
*/
export interface GetWirelessFailedConnectionsOutputArgs {
/**
* apTag query parameter. Filter results by AP Tag
*/
apTag?: pulumi.Input<string>;
/**
* band query parameter. Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.
*/
band?: pulumi.Input<string>;
/**
* clientId query parameter. Filter by client MAC
*/
clientId?: pulumi.Input<string>;
/**
* networkId path parameter. Network ID
*/
networkId: pulumi.Input<string>;
/**
* serial query parameter. Filter by AP
*/
serial?: pulumi.Input<string>;
/**
* ssid query parameter. Filter results by SSID
*/
ssid?: pulumi.Input<number>;
/**
* t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 180 days from today.
*/
t0?: pulumi.Input<string>;
/**
* t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 7 days after t0.
*/
t1?: pulumi.Input<string>;
/**
* timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days.
*/
timespan?: pulumi.Input<number>;
/**
* vlan query parameter. Filter results by VLAN
*/
vlan?: pulumi.Input<number>;
}