1. Packages
  2. Meraki Provider
  3. API Docs
  4. organizations
  5. getSwitchPortsBySwitch
Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi

meraki.organizations.getSwitchPortsBySwitch

Explore with Pulumi AI

meraki logo
Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi

    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);
    
    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)
    
    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
    	})
    }
    
    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),
        };
    });
    
    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()));
        }
    }
    
    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}
    

    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>
    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]
    func GetSwitchPortsBySwitch(ctx *Context, args *GetSwitchPortsBySwitchArgs, opts ...InvokeOption) (*GetSwitchPortsBySwitchResult, error)
    func GetSwitchPortsBySwitchOutput(ctx *Context, args *GetSwitchPortsBySwitchOutputArgs, opts ...InvokeOption) GetSwitchPortsBySwitchResultOutput

    > 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)
    }
    public static CompletableFuture<GetSwitchPortsBySwitchResult> getSwitchPortsBySwitch(GetSwitchPortsBySwitchArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: meraki:organizations/getSwitchPortsBySwitch:getSwitchPortsBySwitch
      arguments:
        # arguments dictionary

    The following arguments are supported:

    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.
    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.
    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.
    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.
    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.
    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.

    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 string
    The MAC address of the switch.
    Model string
    The model of the switch.
    Name string
    The name of the switch.
    Network GetSwitchPortsBySwitchItemNetwork
    Identifying information of the switch's network.
    Ports List<GetSwitchPortsBySwitchItemPort>
    Ports belonging to the switch
    Serial string
    The serial number of the switch.
    Mac string
    The MAC address of the switch.
    Model string
    The model of the switch.
    Name string
    The name of the switch.
    Network GetSwitchPortsBySwitchItemNetwork
    Identifying information of the switch's network.
    Ports []GetSwitchPortsBySwitchItemPort
    Ports belonging to the switch
    Serial string
    The serial number of the switch.
    mac String
    The MAC address of the switch.
    model String
    The model of the switch.
    name String
    The name of the switch.
    network GetSwitchPortsBySwitchItemNetwork
    Identifying information of the switch's network.
    ports List<GetSwitchPortsBySwitchItemPort>
    Ports belonging to the switch
    serial String
    The serial number of the switch.
    mac string
    The MAC address of the switch.
    model string
    The model of the switch.
    name string
    The name of the switch.
    network GetSwitchPortsBySwitchItemNetwork
    Identifying information of the switch's network.
    ports GetSwitchPortsBySwitchItemPort[]
    Ports belonging to the switch
    serial string
    The serial number of the switch.
    mac str
    The MAC address of the switch.
    model str
    The model of the switch.
    name str
    The name of the switch.
    network GetSwitchPortsBySwitchItemNetwork
    Identifying information of the switch's network.
    ports Sequence[GetSwitchPortsBySwitchItemPort]
    Ports belonging to the switch
    serial str
    The serial number of the switch.
    mac String
    The MAC address of the switch.
    model String
    The model of the switch.
    name String
    The name of the switch.
    network Property Map
    Identifying information of the switch's network.
    ports List<Property Map>
    Ports belonging to the switch
    serial String
    The serial number of the switch.

    GetSwitchPortsBySwitchItemNetwork

    Id string
    The ID of the network.
    Name string
    The name of the network.
    Id string
    The ID of the network.
    Name string
    The name of the network.
    id String
    The ID of the network.
    name String
    The name of the network.
    id string
    The ID of the network.
    name string
    The name of the network.
    id str
    The ID of the network.
    name str
    The name of the network.
    id String
    The ID of the network.
    name String
    The name of the network.

    GetSwitchPortsBySwitchItemPort

    AccessPolicyType 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 string
    The VLANs allowed on the switch port. Only applicable to trunk ports.
    Enabled bool
    The status of the switch port.
    LinkNegotiation string
    The link speed for the switch port.
    Name string
    The name of the switch port.
    PoeEnabled bool
    The PoE status of the switch port.
    PortId string
    The identifier of the switch port.
    RstpEnabled bool
    The rapid spanning tree protocol status.
    StickyMacAllowListLimit int
    The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    StickyMacAllowLists List<string>
    The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    StpGuard string
    The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard').
    Tags List<string>
    The list of tags of the switch port.
    Type string
    The type of the switch port ('trunk' or 'access').
    Vlan 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 int
    The voice VLAN of the switch port. Only applicable to access ports.
    AccessPolicyType 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 string
    The VLANs allowed on the switch port. Only applicable to trunk ports.
    Enabled bool
    The status of the switch port.
    LinkNegotiation string
    The link speed for the switch port.
    Name string
    The name of the switch port.
    PoeEnabled bool
    The PoE status of the switch port.
    PortId string
    The identifier of the switch port.
    RstpEnabled bool
    The rapid spanning tree protocol status.
    StickyMacAllowListLimit int
    The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    StickyMacAllowLists []string
    The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    StpGuard string
    The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard').
    Tags []string
    The list of tags of the switch port.
    Type string
    The type of the switch port ('trunk' or 'access').
    Vlan 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 int
    The voice VLAN of the switch port. Only applicable to access ports.
    accessPolicyType 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 String
    The VLANs allowed on the switch port. Only applicable to trunk ports.
    enabled Boolean
    The status of the switch port.
    linkNegotiation String
    The link speed for the switch port.
    name String
    The name of the switch port.
    poeEnabled Boolean
    The PoE status of the switch port.
    portId String
    The identifier of the switch port.
    rstpEnabled Boolean
    The rapid spanning tree protocol status.
    stickyMacAllowListLimit Integer
    The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    stickyMacAllowLists List<String>
    The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    stpGuard String
    The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard').
    tags List<String>
    The list of tags of the switch port.
    type String
    The type of the switch port ('trunk' or 'access').
    vlan 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 Integer
    The voice VLAN of the switch port. Only applicable to access ports.
    accessPolicyType 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 string
    The VLANs allowed on the switch port. Only applicable to trunk ports.
    enabled boolean
    The status of the switch port.
    linkNegotiation string
    The link speed for the switch port.
    name string
    The name of the switch port.
    poeEnabled boolean
    The PoE status of the switch port.
    portId string
    The identifier of the switch port.
    rstpEnabled boolean
    The rapid spanning tree protocol status.
    stickyMacAllowListLimit number
    The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    stickyMacAllowLists string[]
    The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    stpGuard string
    The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard').
    tags string[]
    The list of tags of the switch port.
    type string
    The type of the switch port ('trunk' or 'access').
    vlan 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 number
    The voice VLAN of the switch port. Only applicable to access ports.
    access_policy_type 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 str
    The VLANs allowed on the switch port. Only applicable to trunk ports.
    enabled bool
    The status of the switch port.
    link_negotiation str
    The link speed for the switch port.
    name str
    The name of the switch port.
    poe_enabled bool
    The PoE status of the switch port.
    port_id str
    The identifier of the switch port.
    rstp_enabled bool
    The rapid spanning tree protocol status.
    sticky_mac_allow_list_limit 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 Sequence[str]
    The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    stp_guard str
    The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard').
    tags Sequence[str]
    The list of tags of the switch port.
    type str
    The type of the switch port ('trunk' or 'access').
    vlan 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 int
    The voice VLAN of the switch port. Only applicable to access ports.
    accessPolicyType 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 String
    The VLANs allowed on the switch port. Only applicable to trunk ports.
    enabled Boolean
    The status of the switch port.
    linkNegotiation String
    The link speed for the switch port.
    name String
    The name of the switch port.
    poeEnabled Boolean
    The PoE status of the switch port.
    portId String
    The identifier of the switch port.
    rstpEnabled Boolean
    The rapid spanning tree protocol status.
    stickyMacAllowListLimit Number
    The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    stickyMacAllowLists List<String>
    The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    stpGuard String
    The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard').
    tags List<String>
    The list of tags of the switch port.
    type String
    The type of the switch port ('trunk' or 'access').
    vlan 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 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.
    meraki logo
    Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi