Cisco Meraki v0.4.1, Mar 15 25

Cisco Meraki v0.4.1 published on Saturday, Mar 15, 2025 by Pulumi

meraki.networks.getClients

Explore with Pulumi AI

Cisco Meraki v0.4.1 published on Saturday, Mar 15, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const example = meraki.networks.getClients({
    clientId: "string",
    networkId: "string",
});
export const merakiNetworksClientsExample = example.then(example => example.item);

import pulumi
import pulumi_meraki as meraki

example = meraki.networks.get_clients(client_id="string",
    network_id="string")
pulumi.export("merakiNetworksClientsExample", 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.GetClients(ctx, &networks.GetClientsArgs{
			ClientId:  "string",
			NetworkId: "string",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("merakiNetworksClientsExample", 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.GetClients.Invoke(new()
    {
        ClientId = "string",
        NetworkId = "string",
    });

    return new Dictionary<string, object?>
    {
        ["merakiNetworksClientsExample"] = example.Apply(getClientsResult => getClientsResult.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.GetClientsArgs;
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.getClients(GetClientsArgs.builder()
            .clientId("string")
            .networkId("string")
            .build());

        ctx.export("merakiNetworksClientsExample", example.applyValue(getClientsResult -> getClientsResult.item()));
    }
}

variables:
  example:
    fn::invoke:
      function: meraki:networks:getClients
      arguments:
        clientId: string
        networkId: string
outputs:
  merakiNetworksClientsExample: ${example.item}

Using getClients

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.

TypeScript
Python
Go
C#
Java
YAML

function getClients(args: GetClientsArgs, opts?: InvokeOptions): Promise<GetClientsResult>
function getClientsOutput(args: GetClientsOutputArgs, opts?: InvokeOptions): Output<GetClientsResult>

def get_clients(client_id: Optional[str] = None,
                network_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetClientsResult
def get_clients_output(client_id: Optional[pulumi.Input[str]] = None,
                network_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetClientsResult]

func GetClients(ctx *Context, args *GetClientsArgs, opts ...InvokeOption) (*GetClientsResult, error)
func GetClientsOutput(ctx *Context, args *GetClientsOutputArgs, opts ...InvokeOption) GetClientsResultOutput

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

public static class GetClients 
{
    public static Task<GetClientsResult> InvokeAsync(GetClientsArgs args, InvokeOptions? opts = null)
    public static Output<GetClientsResult> Invoke(GetClientsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetClientsResult> getClients(GetClientsArgs args, InvokeOptions options)
public static Output<GetClientsResult> getClients(GetClientsArgs args, InvokeOptions options)

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

The following arguments are supported:

ClientId string: clientId path parameter. Client ID
NetworkId string: networkId path parameter. Network ID

ClientId string: clientId path parameter. Client ID
NetworkId string: networkId path parameter. Network ID

clientId String: clientId path parameter. Client ID
networkId String: networkId path parameter. Network ID

clientId string: clientId path parameter. Client ID
networkId string: networkId path parameter. Network ID

client_id str: clientId path parameter. Client ID
network_id str: networkId path parameter. Network ID

clientId String: clientId path parameter. Client ID
networkId String: networkId path parameter. Network ID

getClients Result

The following output properties are available:

ClientId string: clientId path parameter. Client ID
Id string: The provider-assigned unique ID for this managed resource.
Item GetClientsItem
NetworkId string: networkId path parameter. Network ID

ClientId string: clientId path parameter. Client ID
Id string: The provider-assigned unique ID for this managed resource.
Item GetClientsItem
NetworkId string: networkId path parameter. Network ID

clientId String: clientId path parameter. Client ID
id String: The provider-assigned unique ID for this managed resource.
item GetClientsItem
networkId String: networkId path parameter. Network ID

clientId string: clientId path parameter. Client ID
id string: The provider-assigned unique ID for this managed resource.
item GetClientsItem
networkId string: networkId path parameter. Network ID

client_id str: clientId path parameter. Client ID
id str: The provider-assigned unique ID for this managed resource.
item GetClientsItem
network_id str: networkId path parameter. Network ID

clientId String: clientId path parameter. Client ID
id String: The provider-assigned unique ID for this managed resource.
item Property Map
networkId String: networkId path parameter. Network ID

Supporting Types

GetClientsItem

Cdps List<GetClientsItemCdp>: The Cisco discover protocol settings for the client
ClientVpnConnections List<GetClientsItemClientVpnConnection>: VPN connections associated with the client
Description string: Short description of the client
FirstSeen int: Timestamp client was first seen in the network
Id string: The ID of the client
Ip string: The IP address of the client
Ip6 string: The IPv6 address of the client
LastSeen int: Timestamp client was last seen in the network
Lldps List<GetClientsItemLldp>: The link layer discover protocol settings for the client
Mac string: The MAC address of the client
Manufacturer string: Manufacturer of the client
Os string: The operating system of the client
RecentDeviceMac string: The MAC address of the node that the device was last connected to
SmInstalled bool: Status of SM for the client
Ssid string: The name of the SSID that the client is connected to
Status string: The connection status of the client
Switchport string: The switch port that the client is connected to
User string: The username of the user of the client
Vlan string: The name of the VLAN that the client is connected to
WirelessCapabilities string: Wireless capabilities of the client

Cdps []GetClientsItemCdp: The Cisco discover protocol settings for the client
ClientVpnConnections []GetClientsItemClientVpnConnection: VPN connections associated with the client
Description string: Short description of the client
FirstSeen int: Timestamp client was first seen in the network
Id string: The ID of the client
Ip string: The IP address of the client
Ip6 string: The IPv6 address of the client
LastSeen int: Timestamp client was last seen in the network
Lldps []GetClientsItemLldp: The link layer discover protocol settings for the client
Mac string: The MAC address of the client
Manufacturer string: Manufacturer of the client
Os string: The operating system of the client
RecentDeviceMac string: The MAC address of the node that the device was last connected to
SmInstalled bool: Status of SM for the client
Ssid string: The name of the SSID that the client is connected to
Status string: The connection status of the client
Switchport string: The switch port that the client is connected to
User string: The username of the user of the client
Vlan string: The name of the VLAN that the client is connected to
WirelessCapabilities string: Wireless capabilities of the client

cdps List<GetClientsItemCdp>: The Cisco discover protocol settings for the client
clientVpnConnections List<GetClientsItemClientVpnConnection>: VPN connections associated with the client
description String: Short description of the client
firstSeen Integer: Timestamp client was first seen in the network
id String: The ID of the client
ip String: The IP address of the client
ip6 String: The IPv6 address of the client
lastSeen Integer: Timestamp client was last seen in the network
lldps List<GetClientsItemLldp>: The link layer discover protocol settings for the client
mac String: The MAC address of the client
manufacturer String: Manufacturer of the client
os String: The operating system of the client
recentDeviceMac String: The MAC address of the node that the device was last connected to
smInstalled Boolean: Status of SM for the client
ssid String: The name of the SSID that the client is connected to
status String: The connection status of the client
switchport String: The switch port that the client is connected to
user String: The username of the user of the client
vlan String: The name of the VLAN that the client is connected to
wirelessCapabilities String: Wireless capabilities of the client

cdps GetClientsItemCdp[]: The Cisco discover protocol settings for the client
clientVpnConnections GetClientsItemClientVpnConnection[]: VPN connections associated with the client
description string: Short description of the client
firstSeen number: Timestamp client was first seen in the network
id string: The ID of the client
ip string: The IP address of the client
ip6 string: The IPv6 address of the client
lastSeen number: Timestamp client was last seen in the network
lldps GetClientsItemLldp[]: The link layer discover protocol settings for the client
mac string: The MAC address of the client
manufacturer string: Manufacturer of the client
os string: The operating system of the client
recentDeviceMac string: The MAC address of the node that the device was last connected to
smInstalled boolean: Status of SM for the client
ssid string: The name of the SSID that the client is connected to
status string: The connection status of the client
switchport string: The switch port that the client is connected to
user string: The username of the user of the client
vlan string: The name of the VLAN that the client is connected to
wirelessCapabilities string: Wireless capabilities of the client

cdps Sequence[GetClientsItemCdp]: The Cisco discover protocol settings for the client
client_vpn_connections Sequence[GetClientsItemClientVpnConnection]: VPN connections associated with the client
description str: Short description of the client
first_seen int: Timestamp client was first seen in the network
id str: The ID of the client
ip str: The IP address of the client
ip6 str: The IPv6 address of the client
last_seen int: Timestamp client was last seen in the network
lldps Sequence[GetClientsItemLldp]: The link layer discover protocol settings for the client
mac str: The MAC address of the client
manufacturer str: Manufacturer of the client
os str: The operating system of the client
recent_device_mac str: The MAC address of the node that the device was last connected to
sm_installed bool: Status of SM for the client
ssid str: The name of the SSID that the client is connected to
status str: The connection status of the client
switchport str: The switch port that the client is connected to
user str: The username of the user of the client
vlan str: The name of the VLAN that the client is connected to
wireless_capabilities str: Wireless capabilities of the client

cdps List<Property Map>: The Cisco discover protocol settings for the client
clientVpnConnections List<Property Map>: VPN connections associated with the client
description String: Short description of the client
firstSeen Number: Timestamp client was first seen in the network
id String: The ID of the client
ip String: The IP address of the client
ip6 String: The IPv6 address of the client
lastSeen Number: Timestamp client was last seen in the network
lldps List<Property Map>: The link layer discover protocol settings for the client
mac String: The MAC address of the client
manufacturer String: Manufacturer of the client
os String: The operating system of the client
recentDeviceMac String: The MAC address of the node that the device was last connected to
smInstalled Boolean: Status of SM for the client
ssid String: The name of the SSID that the client is connected to
status String: The connection status of the client
switchport String: The switch port that the client is connected to
user String: The username of the user of the client
vlan String: The name of the VLAN that the client is connected to
wirelessCapabilities String: Wireless capabilities of the client

GetClientsItemClientVpnConnection

ConnectedAt int: The time the client last connected to the VPN
DisconnectedAt int: The time the client last disconnectd from the VPN
RemoteIp string: The IP address of the VPN the client last connected to

ConnectedAt int: The time the client last connected to the VPN
DisconnectedAt int: The time the client last disconnectd from the VPN
RemoteIp string: The IP address of the VPN the client last connected to

connectedAt Integer: The time the client last connected to the VPN
disconnectedAt Integer: The time the client last disconnectd from the VPN
remoteIp String: The IP address of the VPN the client last connected to

connectedAt number: The time the client last connected to the VPN
disconnectedAt number: The time the client last disconnectd from the VPN
remoteIp string: The IP address of the VPN the client last connected to

connected_at int: The time the client last connected to the VPN
disconnected_at int: The time the client last disconnectd from the VPN
remote_ip str: The IP address of the VPN the client last connected to

connectedAt Number: The time the client last connected to the VPN
disconnectedAt Number: The time the client last disconnectd from the VPN
remoteIp String: The IP address of the VPN the client last connected to

Package Details

Repository: meraki pulumi/pulumi-meraki
License: Apache-2.0
Notes: This Pulumi package is based on the meraki Terraform Provider.

Cisco Meraki v0.4.1 published on Saturday, Mar 15, 2025 by Pulumi

pulumi/pulumi-meraki

meraki.networks.getClients

On this page

On this page

Example Usage

Using getClients

getClients Result

Supporting Types

GetClientsItem

GetClientsItemClientVpnConnection

Package Details

On this page

On this page