Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cisco Meraki Provider
  3. API Docs
  4. organizations
  5. getSwitchPortsBySwitch
Cisco Meraki v0.4.1 published on Saturday, Mar 15, 2025 by Pulumi
pulumi/pulumi-meraki

meraki.organizations.getSwitchPortsBySwitch

Explore with Pulumi AI

Cisco Meraki v0.4.1 published on Saturday, Mar 15, 2025 by Pulumi
pulumi/pulumi-meraki

Example Usage

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

const example = meraki.organizations.getSwitchPortsBySwitch({
    configurationUpdatedAfter: "string",
    endingBefore: "string",
    mac: "string",
    macs: ["string"],
    name: "string",
    networkIds: ["string"],
    organizationId: "string",
    perPage: 1,
    portProfileIds: ["string"],
    serial: "string",
    serials: ["string"],
    startingAfter: "string",
});
export const merakiOrganizationsSwitchPortsBySwitchExample = example.then(example => example.items);
Copy
import pulumi
import pulumi_meraki as meraki

example = meraki.organizations.get_switch_ports_by_switch(configuration_updated_after="string",
    ending_before="string",
    mac="string",
    macs=["string"],
    name="string",
    network_ids=["string"],
    organization_id="string",
    per_page=1,
    port_profile_ids=["string"],
    serial="string",
    serials=["string"],
    starting_after="string")
pulumi.export("merakiOrganizationsSwitchPortsBySwitchExample", example.items)
Copy
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.GetSwitchPortsBySwitch(ctx, &organizations.GetSwitchPortsBySwitchArgs{
			ConfigurationUpdatedAfter: pulumi.StringRef("string"),
			EndingBefore:              pulumi.StringRef("string"),
			Mac:                       pulumi.StringRef("string"),
			Macs: []string{
				"string",
			},
			Name: pulumi.StringRef("string"),
			NetworkIds: []string{
				"string",
			},
			OrganizationId: "string",
			PerPage:        pulumi.IntRef(1),
			PortProfileIds: []string{
				"string",
			},
			Serial: pulumi.StringRef("string"),
			Serials: []string{
				"string",
			},
			StartingAfter: pulumi.StringRef("string"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("merakiOrganizationsSwitchPortsBySwitchExample", example.Items)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Meraki = Pulumi.Meraki;

return await Deployment.RunAsync(() => 
{
    var example = Meraki.Organizations.GetSwitchPortsBySwitch.Invoke(new()
    {
        ConfigurationUpdatedAfter = "string",
        EndingBefore = "string",
        Mac = "string",
        Macs = new[]
        {
            "string",
        },
        Name = "string",
        NetworkIds = new[]
        {
            "string",
        },
        OrganizationId = "string",
        PerPage = 1,
        PortProfileIds = new[]
        {
            "string",
        },
        Serial = "string",
        Serials = new[]
        {
            "string",
        },
        StartingAfter = "string",
    });

    return new Dictionary<string, object?>
    {
        ["merakiOrganizationsSwitchPortsBySwitchExample"] = example.Apply(getSwitchPortsBySwitchResult => getSwitchPortsBySwitchResult.Items),
    };
});
Copy
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.GetSwitchPortsBySwitchArgs;
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.getSwitchPortsBySwitch(GetSwitchPortsBySwitchArgs.builder()
            .configurationUpdatedAfter("string")
            .endingBefore("string")
            .mac("string")
            .macs("string")
            .name("string")
            .networkIds("string")
            .organizationId("string")
            .perPage(1)
            .portProfileIds("string")
            .serial("string")
            .serials("string")
            .startingAfter("string")
            .build());

        ctx.export("merakiOrganizationsSwitchPortsBySwitchExample", example.applyValue(getSwitchPortsBySwitchResult -> getSwitchPortsBySwitchResult.items()));
    }
}
Copy
variables:
  example:
    fn::invoke:
      function: meraki:organizations:getSwitchPortsBySwitch
      arguments:
        configurationUpdatedAfter: string
        endingBefore: string
        mac: string
        macs:
          - string
        name: string
        networkIds:
          - string
        organizationId: string
        perPage: 1
        portProfileIds:
          - string
        serial: string
        serials:
          - string
        startingAfter: string
outputs:
  merakiOrganizationsSwitchPortsBySwitchExample: ${example.items}
Copy

Using getSwitchPortsBySwitch

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 getSwitchPortsBySwitch(args: GetSwitchPortsBySwitchArgs, opts?: InvokeOptions): Promise<GetSwitchPortsBySwitchResult>
function getSwitchPortsBySwitchOutput(args: GetSwitchPortsBySwitchOutputArgs, opts?: InvokeOptions): Output<GetSwitchPortsBySwitchResult>
Copy
def get_switch_ports_by_switch(configuration_updated_after: Optional[str] = None,
                               ending_before: Optional[str] = None,
                               mac: Optional[str] = None,
                               macs: Optional[Sequence[str]] = None,
                               name: Optional[str] = None,
                               network_ids: Optional[Sequence[str]] = None,
                               organization_id: Optional[str] = None,
                               per_page: Optional[int] = None,
                               port_profile_ids: Optional[Sequence[str]] = None,
                               serial: Optional[str] = None,
                               serials: Optional[Sequence[str]] = None,
                               starting_after: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetSwitchPortsBySwitchResult
def get_switch_ports_by_switch_output(configuration_updated_after: Optional[pulumi.Input[str]] = None,
                               ending_before: Optional[pulumi.Input[str]] = None,
                               mac: Optional[pulumi.Input[str]] = None,
                               macs: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                               name: Optional[pulumi.Input[str]] = None,
                               network_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                               organization_id: Optional[pulumi.Input[str]] = None,
                               per_page: Optional[pulumi.Input[int]] = None,
                               port_profile_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                               serial: Optional[pulumi.Input[str]] = None,
                               serials: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                               starting_after: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetSwitchPortsBySwitchResult]
Copy
func GetSwitchPortsBySwitch(ctx *Context, args *GetSwitchPortsBySwitchArgs, opts ...InvokeOption) (*GetSwitchPortsBySwitchResult, error)
func GetSwitchPortsBySwitchOutput(ctx *Context, args *GetSwitchPortsBySwitchOutputArgs, opts ...InvokeOption) GetSwitchPortsBySwitchResultOutput
Copy

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

public static class GetSwitchPortsBySwitch 
{
    public static Task<GetSwitchPortsBySwitchResult> InvokeAsync(GetSwitchPortsBySwitchArgs args, InvokeOptions? opts = null)
    public static Output<GetSwitchPortsBySwitchResult> Invoke(GetSwitchPortsBySwitchInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSwitchPortsBySwitchResult> getSwitchPortsBySwitch(GetSwitchPortsBySwitchArgs args, InvokeOptions options)
public static Output<GetSwitchPortsBySwitchResult> getSwitchPortsBySwitch(GetSwitchPortsBySwitchArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: meraki:organizations/getSwitchPortsBySwitch:getSwitchPortsBySwitch
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

OrganizationId This property is required. string
organizationId path parameter. Organization ID
ConfigurationUpdatedAfter string
configurationUpdatedAfter query parameter. Optional parameter to filter results by switches where the configuration has been updated after the given timestamp.
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.
Mac string
mac query parameter. Optional parameter to filter switchports belonging to switches by MAC address. All returned switches will have a MAC address that contains the search term or is an exact match.
Macs List<string>
macs query parameter. Optional parameter to filter switchports by one or more MAC addresses belonging to devices. All switchports returned belong to MAC addresses of switches that are an exact match.
Name string
name query parameter. Optional parameter to filter switchports belonging to switches by name. All returned switches will have a name that contains the search term or is an exact match.
NetworkIds List<string>
networkIds query parameter. Optional parameter to filter switchports by network.
PerPage int
perPage query parameter. The number of entries per page returned. Acceptable range is 3 50. Default is 50.
PortProfileIds List<string>
portProfileIds query parameter. Optional parameter to filter switchports belonging to the specified port profiles.
Serial string
serial query parameter. Optional parameter to filter switchports belonging to switches by serial number. All returned switches will have a serial number that contains the search term or is an exact match.
Serials List<string>
serials query parameter. Optional parameter to filter switchports belonging to switches with one or more serial numbers. All switchports returned belong to serial numbers of switches that are an exact match.
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.
OrganizationId This property is required. string
organizationId path parameter. Organization ID
ConfigurationUpdatedAfter string
configurationUpdatedAfter query parameter. Optional parameter to filter results by switches where the configuration has been updated after the given timestamp.
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.
Mac string
mac query parameter. Optional parameter to filter switchports belonging to switches by MAC address. All returned switches will have a MAC address that contains the search term or is an exact match.
Macs []string
macs query parameter. Optional parameter to filter switchports by one or more MAC addresses belonging to devices. All switchports returned belong to MAC addresses of switches that are an exact match.
Name string
name query parameter. Optional parameter to filter switchports belonging to switches by name. All returned switches will have a name that contains the search term or is an exact match.
NetworkIds []string
networkIds query parameter. Optional parameter to filter switchports by network.
PerPage int
perPage query parameter. The number of entries per page returned. Acceptable range is 3 50. Default is 50.
PortProfileIds []string
portProfileIds query parameter. Optional parameter to filter switchports belonging to the specified port profiles.
Serial string
serial query parameter. Optional parameter to filter switchports belonging to switches by serial number. All returned switches will have a serial number that contains the search term or is an exact match.
Serials []string
serials query parameter. Optional parameter to filter switchports belonging to switches with one or more serial numbers. All switchports returned belong to serial numbers of switches that are an exact match.
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.
organizationId This property is required. String
organizationId path parameter. Organization ID
configurationUpdatedAfter String
configurationUpdatedAfter query parameter. Optional parameter to filter results by switches where the configuration has been updated after the given timestamp.
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.
mac String
mac query parameter. Optional parameter to filter switchports belonging to switches by MAC address. All returned switches will have a MAC address that contains the search term or is an exact match.
macs List<String>
macs query parameter. Optional parameter to filter switchports by one or more MAC addresses belonging to devices. All switchports returned belong to MAC addresses of switches that are an exact match.
name String
name query parameter. Optional parameter to filter switchports belonging to switches by name. All returned switches will have a name that contains the search term or is an exact match.
networkIds List<String>
networkIds query parameter. Optional parameter to filter switchports by network.
perPage Integer
perPage query parameter. The number of entries per page returned. Acceptable range is 3 50. Default is 50.
portProfileIds List<String>
portProfileIds query parameter. Optional parameter to filter switchports belonging to the specified port profiles.
serial String
serial query parameter. Optional parameter to filter switchports belonging to switches by serial number. All returned switches will have a serial number that contains the search term or is an exact match.
serials List<String>
serials query parameter. Optional parameter to filter switchports belonging to switches with one or more serial numbers. All switchports returned belong to serial numbers of switches that are an exact match.
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.
organizationId This property is required. string
organizationId path parameter. Organization ID
configurationUpdatedAfter string
configurationUpdatedAfter query parameter. Optional parameter to filter results by switches where the configuration has been updated after the given timestamp.
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.
mac string
mac query parameter. Optional parameter to filter switchports belonging to switches by MAC address. All returned switches will have a MAC address that contains the search term or is an exact match.
macs string[]
macs query parameter. Optional parameter to filter switchports by one or more MAC addresses belonging to devices. All switchports returned belong to MAC addresses of switches that are an exact match.
name string
name query parameter. Optional parameter to filter switchports belonging to switches by name. All returned switches will have a name that contains the search term or is an exact match.
networkIds string[]
networkIds query parameter. Optional parameter to filter switchports by network.
perPage number
perPage query parameter. The number of entries per page returned. Acceptable range is 3 50. Default is 50.
portProfileIds string[]
portProfileIds query parameter. Optional parameter to filter switchports belonging to the specified port profiles.
serial string
serial query parameter. Optional parameter to filter switchports belonging to switches by serial number. All returned switches will have a serial number that contains the search term or is an exact match.
serials string[]
serials query parameter. Optional parameter to filter switchports belonging to switches with one or more serial numbers. All switchports returned belong to serial numbers of switches that are an exact match.
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.
organization_id This property is required. str
organizationId path parameter. Organization ID
configuration_updated_after str
configurationUpdatedAfter query parameter. Optional parameter to filter results by switches where the configuration has been updated after the given timestamp.
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.
mac str
mac query parameter. Optional parameter to filter switchports belonging to switches by MAC address. All returned switches will have a MAC address that contains the search term or is an exact match.
macs Sequence[str]
macs query parameter. Optional parameter to filter switchports by one or more MAC addresses belonging to devices. All switchports returned belong to MAC addresses of switches that are an exact match.
name str
name query parameter. Optional parameter to filter switchports belonging to switches by name. All returned switches will have a name that contains the search term or is an exact match.
network_ids Sequence[str]
networkIds query parameter. Optional parameter to filter switchports by network.
per_page int
perPage query parameter. The number of entries per page returned. Acceptable range is 3 50. Default is 50.
port_profile_ids Sequence[str]
portProfileIds query parameter. Optional parameter to filter switchports belonging to the specified port profiles.
serial str
serial query parameter. Optional parameter to filter switchports belonging to switches by serial number. All returned switches will have a serial number that contains the search term or is an exact match.
serials Sequence[str]
serials query parameter. Optional parameter to filter switchports belonging to switches with one or more serial numbers. All switchports returned belong to serial numbers of switches that are an exact match.
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.
organizationId This property is required. String
organizationId path parameter. Organization ID
configurationUpdatedAfter String
configurationUpdatedAfter query parameter. Optional parameter to filter results by switches where the configuration has been updated after the given timestamp.
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.
mac String
mac query parameter. Optional parameter to filter switchports belonging to switches by MAC address. All returned switches will have a MAC address that contains the search term or is an exact match.
macs List<String>
macs query parameter. Optional parameter to filter switchports by one or more MAC addresses belonging to devices. All switchports returned belong to MAC addresses of switches that are an exact match.
name String
name query parameter. Optional parameter to filter switchports belonging to switches by name. All returned switches will have a name that contains the search term or is an exact match.
networkIds List<String>
networkIds query parameter. Optional parameter to filter switchports by network.
perPage Number
perPage query parameter. The number of entries per page returned. Acceptable range is 3 50. Default is 50.
portProfileIds List<String>
portProfileIds query parameter. Optional parameter to filter switchports belonging to the specified port profiles.
serial String
serial query parameter. Optional parameter to filter switchports belonging to switches by serial number. All returned switches will have a serial number that contains the search term or is an exact match.
serials List<String>
serials query parameter. Optional parameter to filter switchports belonging to switches with one or more serial numbers. All switchports returned belong to serial numbers of switches that are an exact match.
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.

getSwitchPortsBySwitch Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Items List<GetSwitchPortsBySwitchItem>
Array of ResponseSwitchGetOrganizationSwitchPortsBySwitch
OrganizationId string
organizationId path parameter. Organization ID
ConfigurationUpdatedAfter string
configurationUpdatedAfter query parameter. Optional parameter to filter results by switches where the configuration has been updated after the given timestamp.
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.
Mac string
mac query parameter. Optional parameter to filter switchports belonging to switches by MAC address. All returned switches will have a MAC address that contains the search term or is an exact match.
Macs List<string>
macs query parameter. Optional parameter to filter switchports by one or more MAC addresses belonging to devices. All switchports returned belong to MAC addresses of switches that are an exact match.
Name string
name query parameter. Optional parameter to filter switchports belonging to switches by name. All returned switches will have a name that contains the search term or is an exact match.
NetworkIds List<string>
networkIds query parameter. Optional parameter to filter switchports by network.
PerPage int
perPage query parameter. The number of entries per page returned. Acceptable range is 3 50. Default is 50.
PortProfileIds List<string>
portProfileIds query parameter. Optional parameter to filter switchports belonging to the specified port profiles.
Serial string
serial query parameter. Optional parameter to filter switchports belonging to switches by serial number. All returned switches will have a serial number that contains the search term or is an exact match.
Serials List<string>
serials query parameter. Optional parameter to filter switchports belonging to switches with one or more serial numbers. All switchports returned belong to serial numbers of switches that are an exact match.
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.
Items []GetSwitchPortsBySwitchItem
Array of ResponseSwitchGetOrganizationSwitchPortsBySwitch
OrganizationId string
organizationId path parameter. Organization ID
ConfigurationUpdatedAfter string
configurationUpdatedAfter query parameter. Optional parameter to filter results by switches where the configuration has been updated after the given timestamp.
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.
Mac string
mac query parameter. Optional parameter to filter switchports belonging to switches by MAC address. All returned switches will have a MAC address that contains the search term or is an exact match.
Macs []string
macs query parameter. Optional parameter to filter switchports by one or more MAC addresses belonging to devices. All switchports returned belong to MAC addresses of switches that are an exact match.
Name string
name query parameter. Optional parameter to filter switchports belonging to switches by name. All returned switches will have a name that contains the search term or is an exact match.
NetworkIds []string
networkIds query parameter. Optional parameter to filter switchports by network.
PerPage int
perPage query parameter. The number of entries per page returned. Acceptable range is 3 50. Default is 50.
PortProfileIds []string
portProfileIds query parameter. Optional parameter to filter switchports belonging to the specified port profiles.
Serial string
serial query parameter. Optional parameter to filter switchports belonging to switches by serial number. All returned switches will have a serial number that contains the search term or is an exact match.
Serials []string
serials query parameter. Optional parameter to filter switchports belonging to switches with one or more serial numbers. All switchports returned belong to serial numbers of switches that are an exact match.
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.
items List<GetSwitchPortsBySwitchItem>
Array of ResponseSwitchGetOrganizationSwitchPortsBySwitch
organizationId String
organizationId path parameter. Organization ID
configurationUpdatedAfter String
configurationUpdatedAfter query parameter. Optional parameter to filter results by switches where the configuration has been updated after the given timestamp.
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.
mac String
mac query parameter. Optional parameter to filter switchports belonging to switches by MAC address. All returned switches will have a MAC address that contains the search term or is an exact match.
macs List<String>
macs query parameter. Optional parameter to filter switchports by one or more MAC addresses belonging to devices. All switchports returned belong to MAC addresses of switches that are an exact match.
name String
name query parameter. Optional parameter to filter switchports belonging to switches by name. All returned switches will have a name that contains the search term or is an exact match.
networkIds List<String>
networkIds query parameter. Optional parameter to filter switchports by network.
perPage Integer
perPage query parameter. The number of entries per page returned. Acceptable range is 3 50. Default is 50.
portProfileIds List<String>
portProfileIds query parameter. Optional parameter to filter switchports belonging to the specified port profiles.
serial String
serial query parameter. Optional parameter to filter switchports belonging to switches by serial number. All returned switches will have a serial number that contains the search term or is an exact match.
serials List<String>
serials query parameter. Optional parameter to filter switchports belonging to switches with one or more serial numbers. All switchports returned belong to serial numbers of switches that are an exact match.
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.
items GetSwitchPortsBySwitchItem[]
Array of ResponseSwitchGetOrganizationSwitchPortsBySwitch
organizationId string
organizationId path parameter. Organization ID
configurationUpdatedAfter string
configurationUpdatedAfter query parameter. Optional parameter to filter results by switches where the configuration has been updated after the given timestamp.
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.
mac string
mac query parameter. Optional parameter to filter switchports belonging to switches by MAC address. All returned switches will have a MAC address that contains the search term or is an exact match.
macs string[]
macs query parameter. Optional parameter to filter switchports by one or more MAC addresses belonging to devices. All switchports returned belong to MAC addresses of switches that are an exact match.
name string
name query parameter. Optional parameter to filter switchports belonging to switches by name. All returned switches will have a name that contains the search term or is an exact match.
networkIds string[]
networkIds query parameter. Optional parameter to filter switchports by network.
perPage number
perPage query parameter. The number of entries per page returned. Acceptable range is 3 50. Default is 50.
portProfileIds string[]
portProfileIds query parameter. Optional parameter to filter switchports belonging to the specified port profiles.
serial string
serial query parameter. Optional parameter to filter switchports belonging to switches by serial number. All returned switches will have a serial number that contains the search term or is an exact match.
serials string[]
serials query parameter. Optional parameter to filter switchports belonging to switches with one or more serial numbers. All switchports returned belong to serial numbers of switches that are an exact match.
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.
items Sequence[GetSwitchPortsBySwitchItem]
Array of ResponseSwitchGetOrganizationSwitchPortsBySwitch
organization_id str
organizationId path parameter. Organization ID
configuration_updated_after str
configurationUpdatedAfter query parameter. Optional parameter to filter results by switches where the configuration has been updated after the given timestamp.
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.
mac str
mac query parameter. Optional parameter to filter switchports belonging to switches by MAC address. All returned switches will have a MAC address that contains the search term or is an exact match.
macs Sequence[str]
macs query parameter. Optional parameter to filter switchports by one or more MAC addresses belonging to devices. All switchports returned belong to MAC addresses of switches that are an exact match.
name str
name query parameter. Optional parameter to filter switchports belonging to switches by name. All returned switches will have a name that contains the search term or is an exact match.
network_ids Sequence[str]
networkIds query parameter. Optional parameter to filter switchports by network.
per_page int
perPage query parameter. The number of entries per page returned. Acceptable range is 3 50. Default is 50.
port_profile_ids Sequence[str]
portProfileIds query parameter. Optional parameter to filter switchports belonging to the specified port profiles.
serial str
serial query parameter. Optional parameter to filter switchports belonging to switches by serial number. All returned switches will have a serial number that contains the search term or is an exact match.
serials Sequence[str]
serials query parameter. Optional parameter to filter switchports belonging to switches with one or more serial numbers. All switchports returned belong to serial numbers of switches that are an exact match.
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.
items List<Property Map>
Array of ResponseSwitchGetOrganizationSwitchPortsBySwitch
organizationId String
organizationId path parameter. Organization ID
configurationUpdatedAfter String
configurationUpdatedAfter query parameter. Optional parameter to filter results by switches where the configuration has been updated after the given timestamp.
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.
mac String
mac query parameter. Optional parameter to filter switchports belonging to switches by MAC address. All returned switches will have a MAC address that contains the search term or is an exact match.
macs List<String>
macs query parameter. Optional parameter to filter switchports by one or more MAC addresses belonging to devices. All switchports returned belong to MAC addresses of switches that are an exact match.
name String
name query parameter. Optional parameter to filter switchports belonging to switches by name. All returned switches will have a name that contains the search term or is an exact match.
networkIds List<String>
networkIds query parameter. Optional parameter to filter switchports by network.
perPage Number
perPage query parameter. The number of entries per page returned. Acceptable range is 3 50. Default is 50.
portProfileIds List<String>
portProfileIds query parameter. Optional parameter to filter switchports belonging to the specified port profiles.
serial String
serial query parameter. Optional parameter to filter switchports belonging to switches by serial number. All returned switches will have a serial number that contains the search term or is an exact match.
serials List<String>
serials query parameter. Optional parameter to filter switchports belonging to switches with one or more serial numbers. All switchports returned belong to serial numbers of switches that are an exact match.
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

GetSwitchPortsBySwitchItem

Mac This property is required. string
The MAC address of the switch.
Model This property is required. string
The model of the switch.
Name This property is required. string
The name of the switch.
Network This property is required. GetSwitchPortsBySwitchItemNetwork
Identifying information of the switch's network.
Ports This property is required. List<GetSwitchPortsBySwitchItemPort>
Ports belonging to the switch
Serial This property is required. string
The serial number of the switch.
Mac This property is required. string
The MAC address of the switch.
Model This property is required. string
The model of the switch.
Name This property is required. string
The name of the switch.
Network This property is required. GetSwitchPortsBySwitchItemNetwork
Identifying information of the switch's network.
Ports This property is required. []GetSwitchPortsBySwitchItemPort
Ports belonging to the switch
Serial This property is required. string
The serial number of the switch.
mac This property is required. String
The MAC address of the switch.
model This property is required. String
The model of the switch.
name This property is required. String
The name of the switch.
network This property is required. GetSwitchPortsBySwitchItemNetwork
Identifying information of the switch's network.
ports This property is required. List<GetSwitchPortsBySwitchItemPort>
Ports belonging to the switch
serial This property is required. String
The serial number of the switch.
mac This property is required. string
The MAC address of the switch.
model This property is required. string
The model of the switch.
name This property is required. string
The name of the switch.
network This property is required. GetSwitchPortsBySwitchItemNetwork
Identifying information of the switch's network.
ports This property is required. GetSwitchPortsBySwitchItemPort[]
Ports belonging to the switch
serial This property is required. string
The serial number of the switch.
mac This property is required. str
The MAC address of the switch.
model This property is required. str
The model of the switch.
name This property is required. str
The name of the switch.
network This property is required. GetSwitchPortsBySwitchItemNetwork
Identifying information of the switch's network.
ports This property is required. Sequence[GetSwitchPortsBySwitchItemPort]
Ports belonging to the switch
serial This property is required. str
The serial number of the switch.
mac This property is required. String
The MAC address of the switch.
model This property is required. String
The model of the switch.
name This property is required. String
The name of the switch.
network This property is required. Property Map
Identifying information of the switch's network.
ports This property is required. List<Property Map>
Ports belonging to the switch
serial This property is required. String
The serial number of the switch.

GetSwitchPortsBySwitchItemNetwork

Id This property is required. string
The ID of the network.
Name This property is required. string
The name of the network.
Id This property is required. string
The ID of the network.
Name This property is required. string
The name of the network.
id This property is required. String
The ID of the network.
name This property is required. String
The name of the network.
id This property is required. string
The ID of the network.
name This property is required. string
The name of the network.
id This property is required. str
The ID of the network.
name This property is required. str
The name of the network.
id This property is required. String
The ID of the network.
name This property is required. String
The name of the network.

GetSwitchPortsBySwitchItemPort

AccessPolicyType This property is required. string
The type of the access policy of the switch port. Only applicable to access ports. Can be one of 'Open', 'Custom access policy', 'MAC allow list' or 'Sticky MAC allow list'.
AllowedVlans This property is required. string
The VLANs allowed on the switch port. Only applicable to trunk ports.
Enabled This property is required. bool
The status of the switch port.
LinkNegotiation This property is required. string
The link speed for the switch port.
Name This property is required. string
The name of the switch port.
PoeEnabled This property is required. bool
The PoE status of the switch port.
PortId This property is required. string
The identifier of the switch port.
RstpEnabled This property is required. bool
The rapid spanning tree protocol status.
StickyMacAllowListLimit This property is required. int
The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
StickyMacAllowLists This property is required. List<string>
The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
StpGuard This property is required. string
The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard').
Tags This property is required. List<string>
The list of tags of the switch port.
Type This property is required. string
The type of the switch port ('trunk' or 'access').
Vlan This property is required. int
The VLAN of the switch port. For a trunk port, this is the native VLAN. A null value will clear the value set for trunk ports.
VoiceVlan This property is required. int
The voice VLAN of the switch port. Only applicable to access ports.
AccessPolicyType This property is required. string
The type of the access policy of the switch port. Only applicable to access ports. Can be one of 'Open', 'Custom access policy', 'MAC allow list' or 'Sticky MAC allow list'.
AllowedVlans This property is required. string
The VLANs allowed on the switch port. Only applicable to trunk ports.
Enabled This property is required. bool
The status of the switch port.
LinkNegotiation This property is required. string
The link speed for the switch port.
Name This property is required. string
The name of the switch port.
PoeEnabled This property is required. bool
The PoE status of the switch port.
PortId This property is required. string
The identifier of the switch port.
RstpEnabled This property is required. bool
The rapid spanning tree protocol status.
StickyMacAllowListLimit This property is required. int
The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
StickyMacAllowLists This property is required. []string
The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
StpGuard This property is required. string
The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard').
Tags This property is required. []string
The list of tags of the switch port.
Type This property is required. string
The type of the switch port ('trunk' or 'access').
Vlan This property is required. int
The VLAN of the switch port. For a trunk port, this is the native VLAN. A null value will clear the value set for trunk ports.
VoiceVlan This property is required. int
The voice VLAN of the switch port. Only applicable to access ports.
accessPolicyType This property is required. String
The type of the access policy of the switch port. Only applicable to access ports. Can be one of 'Open', 'Custom access policy', 'MAC allow list' or 'Sticky MAC allow list'.
allowedVlans This property is required. String
The VLANs allowed on the switch port. Only applicable to trunk ports.
enabled This property is required. Boolean
The status of the switch port.
linkNegotiation This property is required. String
The link speed for the switch port.
name This property is required. String
The name of the switch port.
poeEnabled This property is required. Boolean
The PoE status of the switch port.
portId This property is required. String
The identifier of the switch port.
rstpEnabled This property is required. Boolean
The rapid spanning tree protocol status.
stickyMacAllowListLimit This property is required. Integer
The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
stickyMacAllowLists This property is required. List<String>
The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
stpGuard This property is required. String
The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard').
tags This property is required. List<String>
The list of tags of the switch port.
type This property is required. String
The type of the switch port ('trunk' or 'access').
vlan This property is required. Integer
The VLAN of the switch port. For a trunk port, this is the native VLAN. A null value will clear the value set for trunk ports.
voiceVlan This property is required. Integer
The voice VLAN of the switch port. Only applicable to access ports.
accessPolicyType This property is required. string
The type of the access policy of the switch port. Only applicable to access ports. Can be one of 'Open', 'Custom access policy', 'MAC allow list' or 'Sticky MAC allow list'.
allowedVlans This property is required. string
The VLANs allowed on the switch port. Only applicable to trunk ports.
enabled This property is required. boolean
The status of the switch port.
linkNegotiation This property is required. string
The link speed for the switch port.
name This property is required. string
The name of the switch port.
poeEnabled This property is required. boolean
The PoE status of the switch port.
portId This property is required. string
The identifier of the switch port.
rstpEnabled This property is required. boolean
The rapid spanning tree protocol status.
stickyMacAllowListLimit This property is required. number
The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
stickyMacAllowLists This property is required. string[]
The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
stpGuard This property is required. string
The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard').
tags This property is required. string[]
The list of tags of the switch port.
type This property is required. string
The type of the switch port ('trunk' or 'access').
vlan This property is required. number
The VLAN of the switch port. For a trunk port, this is the native VLAN. A null value will clear the value set for trunk ports.
voiceVlan This property is required. number
The voice VLAN of the switch port. Only applicable to access ports.
access_policy_type This property is required. str
The type of the access policy of the switch port. Only applicable to access ports. Can be one of 'Open', 'Custom access policy', 'MAC allow list' or 'Sticky MAC allow list'.
allowed_vlans This property is required. str
The VLANs allowed on the switch port. Only applicable to trunk ports.
enabled This property is required. bool
The status of the switch port.
link_negotiation This property is required. str
The link speed for the switch port.
name This property is required. str
The name of the switch port.
poe_enabled This property is required. bool
The PoE status of the switch port.
port_id This property is required. str
The identifier of the switch port.
rstp_enabled This property is required. bool
The rapid spanning tree protocol status.
sticky_mac_allow_list_limit This property is required. int
The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
sticky_mac_allow_lists This property is required. Sequence[str]
The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
stp_guard This property is required. str
The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard').
tags This property is required. Sequence[str]
The list of tags of the switch port.
type This property is required. str
The type of the switch port ('trunk' or 'access').
vlan This property is required. int
The VLAN of the switch port. For a trunk port, this is the native VLAN. A null value will clear the value set for trunk ports.
voice_vlan This property is required. int
The voice VLAN of the switch port. Only applicable to access ports.
accessPolicyType This property is required. String
The type of the access policy of the switch port. Only applicable to access ports. Can be one of 'Open', 'Custom access policy', 'MAC allow list' or 'Sticky MAC allow list'.
allowedVlans This property is required. String
The VLANs allowed on the switch port. Only applicable to trunk ports.
enabled This property is required. Boolean
The status of the switch port.
linkNegotiation This property is required. String
The link speed for the switch port.
name This property is required. String
The name of the switch port.
poeEnabled This property is required. Boolean
The PoE status of the switch port.
portId This property is required. String
The identifier of the switch port.
rstpEnabled This property is required. Boolean
The rapid spanning tree protocol status.
stickyMacAllowListLimit This property is required. Number
The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
stickyMacAllowLists This property is required. List<String>
The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
stpGuard This property is required. String
The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard').
tags This property is required. List<String>
The list of tags of the switch port.
type This property is required. String
The type of the switch port ('trunk' or 'access').
vlan This property is required. Number
The VLAN of the switch port. For a trunk port, this is the native VLAN. A null value will clear the value set for trunk ports.
voiceVlan This property is required. Number
The voice VLAN of the switch port. Only applicable to access ports.

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