1. Packages
  2. Cisco Meraki
  3. API Docs
  4. organizations
  5. getClientsSearch
Meraki v0.1.2 published on Tuesday, May 21, 2024 by Pulumi

meraki.organizations.getClientsSearch

Explore with Pulumi AI

meraki logo
Meraki v0.1.2 published on Tuesday, May 21, 2024 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as meraki from "@pulumi/meraki";
    
    const example = meraki.organizations.getClientsSearch({
        endingBefore: "string",
        mac: "string",
        organizationId: "string",
        perPage: 1,
        startingAfter: "string",
    });
    export const merakiOrganizationsClientsSearchExample = example.then(example => example.item);
    
    import pulumi
    import pulumi_meraki as meraki
    
    example = meraki.organizations.get_clients_search(ending_before="string",
        mac="string",
        organization_id="string",
        per_page=1,
        starting_after="string")
    pulumi.export("merakiOrganizationsClientsSearchExample", example.item)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-meraki/sdk/go/meraki/organizations"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := organizations.GetClientsSearch(ctx, &organizations.GetClientsSearchArgs{
    			EndingBefore:   pulumi.StringRef("string"),
    			Mac:            "string",
    			OrganizationId: "string",
    			PerPage:        pulumi.IntRef(1),
    			StartingAfter:  pulumi.StringRef("string"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("merakiOrganizationsClientsSearchExample", example.Item)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Meraki = Pulumi.Meraki;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Meraki.Organizations.GetClientsSearch.Invoke(new()
        {
            EndingBefore = "string",
            Mac = "string",
            OrganizationId = "string",
            PerPage = 1,
            StartingAfter = "string",
        });
    
        return new Dictionary<string, object?>
        {
            ["merakiOrganizationsClientsSearchExample"] = example.Apply(getClientsSearchResult => getClientsSearchResult.Item),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.meraki.organizations.OrganizationsFunctions;
    import com.pulumi.meraki.organizations.inputs.GetClientsSearchArgs;
    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 = OrganizationsFunctions.getClientsSearch(GetClientsSearchArgs.builder()
                .endingBefore("string")
                .mac("string")
                .organizationId("string")
                .perPage(1)
                .startingAfter("string")
                .build());
    
            ctx.export("merakiOrganizationsClientsSearchExample", example.applyValue(getClientsSearchResult -> getClientsSearchResult.item()));
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: meraki:organizations:getClientsSearch
          Arguments:
            endingBefore: string
            mac: string
            organizationId: string
            perPage: 1
            startingAfter: string
    outputs:
      merakiOrganizationsClientsSearchExample: ${example.item}
    

    Using getClientsSearch

    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 getClientsSearch(args: GetClientsSearchArgs, opts?: InvokeOptions): Promise<GetClientsSearchResult>
    function getClientsSearchOutput(args: GetClientsSearchOutputArgs, opts?: InvokeOptions): Output<GetClientsSearchResult>
    def get_clients_search(ending_before: Optional[str] = None,
                           mac: Optional[str] = None,
                           organization_id: Optional[str] = None,
                           per_page: Optional[int] = None,
                           starting_after: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetClientsSearchResult
    def get_clients_search_output(ending_before: Optional[pulumi.Input[str]] = None,
                           mac: Optional[pulumi.Input[str]] = None,
                           organization_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[GetClientsSearchResult]
    func GetClientsSearch(ctx *Context, args *GetClientsSearchArgs, opts ...InvokeOption) (*GetClientsSearchResult, error)
    func GetClientsSearchOutput(ctx *Context, args *GetClientsSearchOutputArgs, opts ...InvokeOption) GetClientsSearchResultOutput

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

    public static class GetClientsSearch 
    {
        public static Task<GetClientsSearchResult> InvokeAsync(GetClientsSearchArgs args, InvokeOptions? opts = null)
        public static Output<GetClientsSearchResult> Invoke(GetClientsSearchInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetClientsSearchResult> getClientsSearch(GetClientsSearchArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: meraki:organizations/getClientsSearch:getClientsSearch
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Mac string
    mac query parameter. The MAC address of the client. Required.
    OrganizationId string
    organizationId path parameter. Organization 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 5. Default is 5.
    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.
    Mac string
    mac query parameter. The MAC address of the client. Required.
    OrganizationId string
    organizationId path parameter. Organization 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 5. Default is 5.
    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.
    mac String
    mac query parameter. The MAC address of the client. Required.
    organizationId String
    organizationId path parameter. Organization 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 5. Default is 5.
    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.
    mac string
    mac query parameter. The MAC address of the client. Required.
    organizationId string
    organizationId path parameter. Organization 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 5. Default is 5.
    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.
    mac str
    mac query parameter. The MAC address of the client. Required.
    organization_id str
    organizationId path parameter. Organization 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 5. Default is 5.
    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.
    mac String
    mac query parameter. The MAC address of the client. Required.
    organizationId String
    organizationId path parameter. Organization 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 5. Default is 5.
    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.

    getClientsSearch Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Item GetClientsSearchItem
    Mac string
    mac query parameter. The MAC address of the client. Required.
    OrganizationId string
    organizationId path parameter. Organization 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 5. Default is 5.
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    Item GetClientsSearchItem
    Mac string
    mac query parameter. The MAC address of the client. Required.
    OrganizationId string
    organizationId path parameter. Organization 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 5. Default is 5.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    item GetClientsSearchItem
    mac String
    mac query parameter. The MAC address of the client. Required.
    organizationId String
    organizationId path parameter. Organization 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 5. Default is 5.
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    item GetClientsSearchItem
    mac string
    mac query parameter. The MAC address of the client. Required.
    organizationId string
    organizationId path parameter. Organization 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 5. Default is 5.
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    item GetClientsSearchItem
    mac str
    mac query parameter. The MAC address of the client. Required.
    organization_id str
    organizationId path parameter. Organization 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 5. Default is 5.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    item Property Map
    mac String
    mac query parameter. The MAC address of the client. Required.
    organizationId String
    organizationId path parameter. Organization 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 5. Default is 5.
    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

    GetClientsSearchItem

    GetClientsSearchItemRecord

    cdp String
    clientVpnConnections List<Property Map>
    description String
    firstSeen Number
    ip String
    ip6 String
    lastSeen Number
    lldps List<String>
    network Property Map
    os String
    smInstalled Boolean
    ssid String
    status String
    switchport String
    user String
    vlan String
    wirelessCapabilities String

    GetClientsSearchItemRecordClientVpnConnection

    connectedAt Integer
    disconnectedAt Integer
    remoteIp String

    GetClientsSearchItemRecordNetwork

    EnrollmentString string
    Id string
    IsBoundToConfigTemplate bool
    Name string
    Notes string
    OrganizationId string
    ProductTypes List<string>
    Tags List<string>
    TimeZone string
    EnrollmentString string
    Id string
    IsBoundToConfigTemplate bool
    Name string
    Notes string
    OrganizationId string
    ProductTypes []string
    Tags []string
    TimeZone string
    enrollmentString String
    id String
    isBoundToConfigTemplate Boolean
    name String
    notes String
    organizationId String
    productTypes List<String>
    tags List<String>
    timeZone String
    enrollmentString string
    id string
    isBoundToConfigTemplate boolean
    name string
    notes string
    organizationId string
    productTypes string[]
    tags string[]
    timeZone string
    enrollmentString String
    id String
    isBoundToConfigTemplate Boolean
    name String
    notes String
    organizationId String
    productTypes List<String>
    tags List<String>
    timeZone String

    Package Details

    Repository
    meraki pulumi/pulumi-meraki
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the meraki Terraform Provider.
    meraki logo
    Meraki v0.1.2 published on Tuesday, May 21, 2024 by Pulumi