@pulumi/meraki
Version:
A Pulumi package for creating and managing Cisco Meraki resources. Based on terraform-provider-meraki: version v0.2.0
206 lines (205 loc) • 7.67 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.getWirelessSignalQualityHistory({
* apTag: "string",
* autoResolution: false,
* band: "string",
* clientId: "string",
* deviceSerial: "string",
* networkId: "string",
* resolution: 1,
* ssid: 1,
* t0: "string",
* t1: "string",
* timespan: 1,
* });
* export const merakiNetworksWirelessSignalQualityHistoryExample = example.then(example => example.items);
* ```
*/
export declare function getWirelessSignalQualityHistory(args: GetWirelessSignalQualityHistoryArgs, opts?: pulumi.InvokeOptions): Promise<GetWirelessSignalQualityHistoryResult>;
/**
* A collection of arguments for invoking getWirelessSignalQualityHistory.
*/
export interface GetWirelessSignalQualityHistoryArgs {
/**
* apTag query parameter. Filter results by AP tag; either :clientId or :deviceSerial must be jointly specified.
*/
apTag?: string;
/**
* autoResolution query parameter. Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false.
*/
autoResolution?: boolean;
/**
* band query parameter. Filter results by band (either '2.4', '5' or '6').
*/
band?: string;
/**
* clientId query parameter. Filter results by network client.
*/
clientId?: string;
/**
* deviceSerial query parameter. Filter results by device.
*/
deviceSerial?: string;
/**
* networkId path parameter. Network ID
*/
networkId: string;
/**
* resolution query parameter. The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400.
*/
resolution?: number;
/**
* ssid query parameter. Filter results by SSID number.
*/
ssid?: number;
/**
* t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
*/
t0?: string;
/**
* t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 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 31 days. The default is 7 days.
*/
timespan?: number;
}
/**
* A collection of values returned by getWirelessSignalQualityHistory.
*/
export interface GetWirelessSignalQualityHistoryResult {
/**
* apTag query parameter. Filter results by AP tag; either :clientId or :deviceSerial must be jointly specified.
*/
readonly apTag?: string;
/**
* autoResolution query parameter. Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false.
*/
readonly autoResolution?: boolean;
/**
* band query parameter. Filter results by band (either '2.4', '5' or '6').
*/
readonly band?: string;
/**
* clientId query parameter. Filter results by network client.
*/
readonly clientId?: string;
/**
* deviceSerial query parameter. Filter results by device.
*/
readonly deviceSerial?: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* Array of ResponseWirelessGetNetworkWirelessSignalQualityHistory
*/
readonly items: outputs.networks.GetWirelessSignalQualityHistoryItem[];
/**
* networkId path parameter. Network ID
*/
readonly networkId: string;
/**
* resolution query parameter. The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400.
*/
readonly resolution?: number;
/**
* ssid query parameter. Filter results by SSID number.
*/
readonly ssid?: number;
/**
* t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
*/
readonly t0?: string;
/**
* t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 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 31 days. The default is 7 days.
*/
readonly timespan?: number;
}
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as meraki from "@pulumi/meraki";
*
* const example = meraki.networks.getWirelessSignalQualityHistory({
* apTag: "string",
* autoResolution: false,
* band: "string",
* clientId: "string",
* deviceSerial: "string",
* networkId: "string",
* resolution: 1,
* ssid: 1,
* t0: "string",
* t1: "string",
* timespan: 1,
* });
* export const merakiNetworksWirelessSignalQualityHistoryExample = example.then(example => example.items);
* ```
*/
export declare function getWirelessSignalQualityHistoryOutput(args: GetWirelessSignalQualityHistoryOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetWirelessSignalQualityHistoryResult>;
/**
* A collection of arguments for invoking getWirelessSignalQualityHistory.
*/
export interface GetWirelessSignalQualityHistoryOutputArgs {
/**
* apTag query parameter. Filter results by AP tag; either :clientId or :deviceSerial must be jointly specified.
*/
apTag?: pulumi.Input<string>;
/**
* autoResolution query parameter. Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false.
*/
autoResolution?: pulumi.Input<boolean>;
/**
* band query parameter. Filter results by band (either '2.4', '5' or '6').
*/
band?: pulumi.Input<string>;
/**
* clientId query parameter. Filter results by network client.
*/
clientId?: pulumi.Input<string>;
/**
* deviceSerial query parameter. Filter results by device.
*/
deviceSerial?: pulumi.Input<string>;
/**
* networkId path parameter. Network ID
*/
networkId: pulumi.Input<string>;
/**
* resolution query parameter. The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400.
*/
resolution?: pulumi.Input<number>;
/**
* ssid query parameter. Filter results by SSID number.
*/
ssid?: pulumi.Input<number>;
/**
* t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
*/
t0?: pulumi.Input<string>;
/**
* t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 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 31 days. The default is 7 days.
*/
timespan?: pulumi.Input<number>;
}