@pulumi/meraki
Version:
A Pulumi package for creating and managing Cisco Meraki resources. Based on terraform-provider-meraki: version v0.2.0
136 lines • 5.65 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.organizations.getDevicesUplinksLossAndLatency({
* ip: "string",
* organizationId: "string",
* t0: "string",
* t1: "string",
* timespan: 1,
* uplink: "string",
* });
* export const merakiOrganizationsDevicesUplinksLossAndLatencyExample = example.then(example => example.items);
* ```
*/
export declare function getDevicesUplinksLossAndLatency(args: GetDevicesUplinksLossAndLatencyArgs, opts?: pulumi.InvokeOptions): Promise<GetDevicesUplinksLossAndLatencyResult>;
/**
* A collection of arguments for invoking getDevicesUplinksLossAndLatency.
*/
export interface GetDevicesUplinksLossAndLatencyArgs {
/**
* ip query parameter. Optional filter for a specific destination IP. Default will return all destination IPs.
*/
ip?: string;
/**
* organizationId path parameter. Organization ID
*/
organizationId: string;
/**
* t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 60 days from today.
*/
t0?: string;
/**
* t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 5 minutes after t0. The latest possible time that t1 can be is 2 minutes into the past.
*/
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 5 minutes. The default is 5 minutes.
*/
timespan?: number;
/**
* uplink query parameter. Optional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, wan3, cellular. Default will return all uplinks.
*/
uplink?: string;
}
/**
* A collection of values returned by getDevicesUplinksLossAndLatency.
*/
export interface GetDevicesUplinksLossAndLatencyResult {
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* ip query parameter. Optional filter for a specific destination IP. Default will return all destination IPs.
*/
readonly ip?: string;
/**
* Array of ResponseOrganizationsGetOrganizationDevicesUplinksLossAndLatency
*/
readonly items: outputs.organizations.GetDevicesUplinksLossAndLatencyItem[];
/**
* organizationId path parameter. Organization ID
*/
readonly organizationId: string;
/**
* t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 60 days from today.
*/
readonly t0?: string;
/**
* t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 5 minutes after t0. The latest possible time that t1 can be is 2 minutes into the past.
*/
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 5 minutes. The default is 5 minutes.
*/
readonly timespan?: number;
/**
* uplink query parameter. Optional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, wan3, cellular. Default will return all uplinks.
*/
readonly uplink?: string;
}
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as meraki from "@pulumi/meraki";
*
* const example = meraki.organizations.getDevicesUplinksLossAndLatency({
* ip: "string",
* organizationId: "string",
* t0: "string",
* t1: "string",
* timespan: 1,
* uplink: "string",
* });
* export const merakiOrganizationsDevicesUplinksLossAndLatencyExample = example.then(example => example.items);
* ```
*/
export declare function getDevicesUplinksLossAndLatencyOutput(args: GetDevicesUplinksLossAndLatencyOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDevicesUplinksLossAndLatencyResult>;
/**
* A collection of arguments for invoking getDevicesUplinksLossAndLatency.
*/
export interface GetDevicesUplinksLossAndLatencyOutputArgs {
/**
* ip query parameter. Optional filter for a specific destination IP. Default will return all destination IPs.
*/
ip?: pulumi.Input<string | undefined>;
/**
* organizationId path parameter. Organization ID
*/
organizationId: pulumi.Input<string>;
/**
* t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 60 days from today.
*/
t0?: pulumi.Input<string | undefined>;
/**
* t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 5 minutes after t0. The latest possible time that t1 can be is 2 minutes into the past.
*/
t1?: pulumi.Input<string | undefined>;
/**
* 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 5 minutes. The default is 5 minutes.
*/
timespan?: pulumi.Input<number | undefined>;
/**
* uplink query parameter. Optional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, wan3, cellular. Default will return all uplinks.
*/
uplink?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=getDevicesUplinksLossAndLatency.d.ts.map