Docs Packages
  1. Packages
  2. Cisco Meraki
  3. API Docs
  4. networks
  5. getSmDevicesPerformanceHistory
Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi
pulumi/pulumi-meraki

meraki.networks.getSmDevicesPerformanceHistory

Explore with Pulumi AI

meraki logo
Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi
pulumi/pulumi-meraki

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as meraki from "@pulumi/meraki";

const example = meraki.networks.getSmDevicesPerformanceHistory({
    deviceId: "string",
    endingBefore: "string",
    networkId: "string",
    perPage: 1,
    startingAfter: "string",
});
export const merakiNetworksSmDevicesPerformanceHistoryExample = example.then(example => example.items);

    import pulumi
import pulumi_meraki as meraki

example = meraki.networks.get_sm_devices_performance_history(device_id="string",
    ending_before="string",
    network_id="string",
    per_page=1,
    starting_after="string")
pulumi.export("merakiNetworksSmDevicesPerformanceHistoryExample", example.items)

    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.GetSmDevicesPerformanceHistory(ctx, &networks.GetSmDevicesPerformanceHistoryArgs{
			DeviceId:      "string",
			EndingBefore:  pulumi.StringRef("string"),
			NetworkId:     "string",
			PerPage:       pulumi.IntRef(1),
			StartingAfter: pulumi.StringRef("string"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("merakiNetworksSmDevicesPerformanceHistoryExample", example.Items)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Meraki = Pulumi.Meraki;

return await Deployment.RunAsync(() => 
{
    var example = Meraki.Networks.GetSmDevicesPerformanceHistory.Invoke(new()
    {
        DeviceId = "string",
        EndingBefore = "string",
        NetworkId = "string",
        PerPage = 1,
        StartingAfter = "string",
    });

    return new Dictionary<string, object?>
    {
        ["merakiNetworksSmDevicesPerformanceHistoryExample"] = example.Apply(getSmDevicesPerformanceHistoryResult => getSmDevicesPerformanceHistoryResult.Items),
    };
});

    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.GetSmDevicesPerformanceHistoryArgs;
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.getSmDevicesPerformanceHistory(GetSmDevicesPerformanceHistoryArgs.builder()
            .deviceId("string")
            .endingBefore("string")
            .networkId("string")
            .perPage(1)
            .startingAfter("string")
            .build());

        ctx.export("merakiNetworksSmDevicesPerformanceHistoryExample", example.applyValue(getSmDevicesPerformanceHistoryResult -> getSmDevicesPerformanceHistoryResult.items()));
    }
}

    variables:
  example:
    fn::invoke:
      Function: meraki:networks:getSmDevicesPerformanceHistory
      Arguments:
        deviceId: string
        endingBefore: string
        networkId: string
        perPage: 1
        startingAfter: string
outputs:
  merakiNetworksSmDevicesPerformanceHistoryExample: ${example.items}

    Using getSmDevicesPerformanceHistory

    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 getSmDevicesPerformanceHistory(args: GetSmDevicesPerformanceHistoryArgs, opts?: InvokeOptions): Promise<GetSmDevicesPerformanceHistoryResult>
function getSmDevicesPerformanceHistoryOutput(args: GetSmDevicesPerformanceHistoryOutputArgs, opts?: InvokeOptions): Output<GetSmDevicesPerformanceHistoryResult>
    def get_sm_devices_performance_history(device_id: Optional[str] = None,
                                       ending_before: Optional[str] = None,
                                       network_id: Optional[str] = None,
                                       per_page: Optional[int] = None,
                                       starting_after: Optional[str] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetSmDevicesPerformanceHistoryResult
def get_sm_devices_performance_history_output(device_id: Optional[pulumi.Input[str]] = None,
                                       ending_before: Optional[pulumi.Input[str]] = None,
                                       network_id: Optional[pulumi.Input[str]] = None,
                                       per_page: Optional[pulumi.Input[int]] = None,
                                       starting_after: Optional[pulumi.Input[str]] = None,
                                       opts: Optional[InvokeOptions] = None) -> Output[GetSmDevicesPerformanceHistoryResult]
    func GetSmDevicesPerformanceHistory(ctx *Context, args *GetSmDevicesPerformanceHistoryArgs, opts ...InvokeOption) (*GetSmDevicesPerformanceHistoryResult, error)
func GetSmDevicesPerformanceHistoryOutput(ctx *Context, args *GetSmDevicesPerformanceHistoryOutputArgs, opts ...InvokeOption) GetSmDevicesPerformanceHistoryResultOutput

    > Note: This function is named GetSmDevicesPerformanceHistory in the Go SDK.

    public static class GetSmDevicesPerformanceHistory 
{
    public static Task<GetSmDevicesPerformanceHistoryResult> InvokeAsync(GetSmDevicesPerformanceHistoryArgs args, InvokeOptions? opts = null)
    public static Output<GetSmDevicesPerformanceHistoryResult> Invoke(GetSmDevicesPerformanceHistoryInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSmDevicesPerformanceHistoryResult> getSmDevicesPerformanceHistory(GetSmDevicesPerformanceHistoryArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: meraki:networks/getSmDevicesPerformanceHistory:getSmDevicesPerformanceHistory
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DeviceId string
    deviceId path parameter. Device ID
    NetworkId string
    networkId path parameter. Network ID
    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.
    PerPage int
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 1000.
    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.
    DeviceId string
    deviceId path parameter. Device ID
    NetworkId string
    networkId path parameter. Network ID
    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.
    PerPage int
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 1000.
    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.
    deviceId String
    deviceId path parameter. Device ID
    networkId String
    networkId path parameter. Network ID
    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.
    perPage Integer
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 1000.
    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.
    deviceId string
    deviceId path parameter. Device ID
    networkId string
    networkId path parameter. Network ID
    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.
    perPage number
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 1000.
    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.
    device_id str
    deviceId path parameter. Device ID
    network_id str
    networkId path parameter. Network ID
    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.
    per_page int
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 1000.
    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.
    deviceId String
    deviceId path parameter. Device ID
    networkId String
    networkId path parameter. Network ID
    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.
    perPage Number
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 1000.
    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.

    getSmDevicesPerformanceHistory Result

    The following output properties are available:

    DeviceId string
    deviceId path parameter. Device ID
    Id string
    The provider-assigned unique ID for this managed resource.
    Items List<GetSmDevicesPerformanceHistoryItem>
    Array of ResponseSmGetNetworkSmDevicePerformanceHistory
    NetworkId string
    networkId path parameter. Network ID
    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.
    PerPage int
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 1000.
    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.
    DeviceId string
    deviceId path parameter. Device ID
    Id string
    The provider-assigned unique ID for this managed resource.
    Items []GetSmDevicesPerformanceHistoryItem
    Array of ResponseSmGetNetworkSmDevicePerformanceHistory
    NetworkId string
    networkId path parameter. Network ID
    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.
    PerPage int
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 1000.
    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.
    deviceId String
    deviceId path parameter. Device ID
    id String
    The provider-assigned unique ID for this managed resource.
    items List<GetSmDevicesPerformanceHistoryItem>
    Array of ResponseSmGetNetworkSmDevicePerformanceHistory
    networkId String
    networkId path parameter. Network ID
    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.
    perPage Integer
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 1000.
    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.
    deviceId string
    deviceId path parameter. Device ID
    id string
    The provider-assigned unique ID for this managed resource.
    items GetSmDevicesPerformanceHistoryItem[]
    Array of ResponseSmGetNetworkSmDevicePerformanceHistory
    networkId string
    networkId path parameter. Network ID
    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.
    perPage number
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 1000.
    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.
    device_id str
    deviceId path parameter. Device ID
    id str
    The provider-assigned unique ID for this managed resource.
    items Sequence[GetSmDevicesPerformanceHistoryItem]
    Array of ResponseSmGetNetworkSmDevicePerformanceHistory
    network_id str
    networkId path parameter. Network ID
    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.
    per_page int
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 1000.
    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.
    deviceId String
    deviceId path parameter. Device ID
    id String
    The provider-assigned unique ID for this managed resource.
    items List<Property Map>
    Array of ResponseSmGetNetworkSmDevicePerformanceHistory
    networkId String
    networkId path parameter. Network ID
    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.
    perPage Number
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 1000.
    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

    GetSmDevicesPerformanceHistoryItem

    CpuPercentUsed double
    The percentage of CPU used as a decimal format.
    DiskUsage GetSmDevicesPerformanceHistoryItemDiskUsage
    An object containing disk usage details.
    MemActive int
    The active RAM on the device.
    MemFree int
    Memory that is not yet in use by the system.
    MemInactive int
    The inactive RAM on the device.
    MemWired int
    Memory used for core OS functions on the device.
    NetworkReceived int
    Network bandwith received.
    NetworkSent int
    Network bandwith transmitted.
    SwapUsed int
    The amount of space being used on the startup disk to swap unused files to and from RAM.
    Ts string
    The time at which the performance was measured.
    CpuPercentUsed float64
    The percentage of CPU used as a decimal format.
    DiskUsage GetSmDevicesPerformanceHistoryItemDiskUsage
    An object containing disk usage details.
    MemActive int
    The active RAM on the device.
    MemFree int
    Memory that is not yet in use by the system.
    MemInactive int
    The inactive RAM on the device.
    MemWired int
    Memory used for core OS functions on the device.
    NetworkReceived int
    Network bandwith received.
    NetworkSent int
    Network bandwith transmitted.
    SwapUsed int
    The amount of space being used on the startup disk to swap unused files to and from RAM.
    Ts string
    The time at which the performance was measured.
    cpuPercentUsed Double
    The percentage of CPU used as a decimal format.
    diskUsage GetSmDevicesPerformanceHistoryItemDiskUsage
    An object containing disk usage details.
    memActive Integer
    The active RAM on the device.
    memFree Integer
    Memory that is not yet in use by the system.
    memInactive Integer
    The inactive RAM on the device.
    memWired Integer
    Memory used for core OS functions on the device.
    networkReceived Integer
    Network bandwith received.
    networkSent Integer
    Network bandwith transmitted.
    swapUsed Integer
    The amount of space being used on the startup disk to swap unused files to and from RAM.
    ts String
    The time at which the performance was measured.
    cpuPercentUsed number
    The percentage of CPU used as a decimal format.
    diskUsage GetSmDevicesPerformanceHistoryItemDiskUsage
    An object containing disk usage details.
    memActive number
    The active RAM on the device.
    memFree number
    Memory that is not yet in use by the system.
    memInactive number
    The inactive RAM on the device.
    memWired number
    Memory used for core OS functions on the device.
    networkReceived number
    Network bandwith received.
    networkSent number
    Network bandwith transmitted.
    swapUsed number
    The amount of space being used on the startup disk to swap unused files to and from RAM.
    ts string
    The time at which the performance was measured.
    cpu_percent_used float
    The percentage of CPU used as a decimal format.
    disk_usage GetSmDevicesPerformanceHistoryItemDiskUsage
    An object containing disk usage details.
    mem_active int
    The active RAM on the device.
    mem_free int
    Memory that is not yet in use by the system.
    mem_inactive int
    The inactive RAM on the device.
    mem_wired int
    Memory used for core OS functions on the device.
    network_received int
    Network bandwith received.
    network_sent int
    Network bandwith transmitted.
    swap_used int
    The amount of space being used on the startup disk to swap unused files to and from RAM.
    ts str
    The time at which the performance was measured.
    cpuPercentUsed Number
    The percentage of CPU used as a decimal format.
    diskUsage Property Map
    An object containing disk usage details.
    memActive Number
    The active RAM on the device.
    memFree Number
    Memory that is not yet in use by the system.
    memInactive Number
    The inactive RAM on the device.
    memWired Number
    Memory used for core OS functions on the device.
    networkReceived Number
    Network bandwith received.
    networkSent Number
    Network bandwith transmitted.
    swapUsed Number
    The amount of space being used on the startup disk to swap unused files to and from RAM.
    ts String
    The time at which the performance was measured.

    GetSmDevicesPerformanceHistoryItemDiskUsage

    C GetSmDevicesPerformanceHistoryItemDiskUsageC
    An object containing current disk usage details.
    C GetSmDevicesPerformanceHistoryItemDiskUsageC
    An object containing current disk usage details.
    c GetSmDevicesPerformanceHistoryItemDiskUsageC
    An object containing current disk usage details.
    c GetSmDevicesPerformanceHistoryItemDiskUsageC
    An object containing current disk usage details.
    c GetSmDevicesPerformanceHistoryItemDiskUsageC
    An object containing current disk usage details.
    c Property Map
    An object containing current disk usage details.

    GetSmDevicesPerformanceHistoryItemDiskUsageC

    Space int
    The available disk space.
    Used int
    The used disk space.
    Space int
    The available disk space.
    Used int
    The used disk space.
    space Integer
    The available disk space.
    used Integer
    The used disk space.
    space number
    The available disk space.
    used number
    The used disk space.
    space int
    The available disk space.
    used int
    The used disk space.
    space Number
    The available disk space.
    used Number
    The used disk space.

    Package Details

    Repository
    meraki pulumi/pulumi-meraki
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the meraki Terraform Provider.
    meraki logo
    Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi
    pulumi/pulumi-meraki