Cisco Meraki v0.4.1 published on Saturday, Mar 15, 2025 by Pulumi
meraki.networks.getSwitchSettings
Explore with Pulumi AI
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as meraki from "@pulumi/meraki";
const example = meraki.networks.getSwitchSettings({
    networkId: "string",
});
export const merakiNetworksSwitchSettingsExample = example.then(example => example.item);
import pulumi
import pulumi_meraki as meraki
example = meraki.networks.get_switch_settings(network_id="string")
pulumi.export("merakiNetworksSwitchSettingsExample", example.item)
package main
import (
	"github.com/pulumi/pulumi-meraki/sdk/go/meraki/networks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := networks.LookupSwitchSettings(ctx, &networks.LookupSwitchSettingsArgs{
			NetworkId: "string",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("merakiNetworksSwitchSettingsExample", example.Item)
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Meraki = Pulumi.Meraki;
return await Deployment.RunAsync(() => 
{
    var example = Meraki.Networks.GetSwitchSettings.Invoke(new()
    {
        NetworkId = "string",
    });
    return new Dictionary<string, object?>
    {
        ["merakiNetworksSwitchSettingsExample"] = example.Apply(getSwitchSettingsResult => getSwitchSettingsResult.Item),
    };
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.meraki.networks.NetworksFunctions;
import com.pulumi.meraki.networks.inputs.GetSwitchSettingsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var example = NetworksFunctions.getSwitchSettings(GetSwitchSettingsArgs.builder()
            .networkId("string")
            .build());
        ctx.export("merakiNetworksSwitchSettingsExample", example.applyValue(getSwitchSettingsResult -> getSwitchSettingsResult.item()));
    }
}
variables:
  example:
    fn::invoke:
      function: meraki:networks:getSwitchSettings
      arguments:
        networkId: string
outputs:
  merakiNetworksSwitchSettingsExample: ${example.item}
Using getSwitchSettings
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 getSwitchSettings(args: GetSwitchSettingsArgs, opts?: InvokeOptions): Promise<GetSwitchSettingsResult>
function getSwitchSettingsOutput(args: GetSwitchSettingsOutputArgs, opts?: InvokeOptions): Output<GetSwitchSettingsResult>def get_switch_settings(network_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetSwitchSettingsResult
def get_switch_settings_output(network_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetSwitchSettingsResult]func LookupSwitchSettings(ctx *Context, args *LookupSwitchSettingsArgs, opts ...InvokeOption) (*LookupSwitchSettingsResult, error)
func LookupSwitchSettingsOutput(ctx *Context, args *LookupSwitchSettingsOutputArgs, opts ...InvokeOption) LookupSwitchSettingsResultOutput> Note: This function is named LookupSwitchSettings in the Go SDK.
public static class GetSwitchSettings 
{
    public static Task<GetSwitchSettingsResult> InvokeAsync(GetSwitchSettingsArgs args, InvokeOptions? opts = null)
    public static Output<GetSwitchSettingsResult> Invoke(GetSwitchSettingsInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetSwitchSettingsResult> getSwitchSettings(GetSwitchSettingsArgs args, InvokeOptions options)
public static Output<GetSwitchSettingsResult> getSwitchSettings(GetSwitchSettingsArgs args, InvokeOptions options)
fn::invoke:
  function: meraki:networks/getSwitchSettings:getSwitchSettings
  arguments:
    # arguments dictionaryThe following arguments are supported:
- NetworkId string
- networkId path parameter. Network ID
- NetworkId string
- networkId path parameter. Network ID
- networkId String
- networkId path parameter. Network ID
- networkId string
- networkId path parameter. Network ID
- network_id str
- networkId path parameter. Network ID
- networkId String
- networkId path parameter. Network ID
getSwitchSettings Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Item
GetSwitch Settings Item 
- NetworkId string
- networkId path parameter. Network ID
- Id string
- The provider-assigned unique ID for this managed resource.
- Item
GetSwitch Settings Item 
- NetworkId string
- networkId path parameter. Network ID
- id String
- The provider-assigned unique ID for this managed resource.
- item
GetSwitch Settings Item 
- networkId String
- networkId path parameter. Network ID
- id string
- The provider-assigned unique ID for this managed resource.
- item
GetSwitch Settings Item 
- networkId string
- networkId path parameter. Network ID
- id str
- The provider-assigned unique ID for this managed resource.
- item
GetSwitch Settings Item 
- network_id str
- networkId path parameter. Network ID
- id String
- The provider-assigned unique ID for this managed resource.
- item Property Map
- networkId String
- networkId path parameter. Network ID
Supporting Types
GetSwitchSettingsItem   
- MacBlocklist GetSwitch Settings Item Mac Blocklist 
- MAC blocklist
- PowerExceptions List<GetSwitch Settings Item Power Exception> 
- Exceptions on a per switch basis to "useCombinedPower"
- UplinkClient GetSampling Switch Settings Item Uplink Client Sampling 
- Uplink client sampling
- UseCombined boolPower 
- The use Combined Power as the default behavior of secondary power supplies on supported devices.
- Vlan int
- Management VLAN
- MacBlocklist GetSwitch Settings Item Mac Blocklist 
- MAC blocklist
- PowerExceptions []GetSwitch Settings Item Power Exception 
- Exceptions on a per switch basis to "useCombinedPower"
- UplinkClient GetSampling Switch Settings Item Uplink Client Sampling 
- Uplink client sampling
- UseCombined boolPower 
- The use Combined Power as the default behavior of secondary power supplies on supported devices.
- Vlan int
- Management VLAN
- macBlocklist GetSwitch Settings Item Mac Blocklist 
- MAC blocklist
- powerExceptions List<GetSwitch Settings Item Power Exception> 
- Exceptions on a per switch basis to "useCombinedPower"
- uplinkClient GetSampling Switch Settings Item Uplink Client Sampling 
- Uplink client sampling
- useCombined BooleanPower 
- The use Combined Power as the default behavior of secondary power supplies on supported devices.
- vlan Integer
- Management VLAN
- macBlocklist GetSwitch Settings Item Mac Blocklist 
- MAC blocklist
- powerExceptions GetSwitch Settings Item Power Exception[] 
- Exceptions on a per switch basis to "useCombinedPower"
- uplinkClient GetSampling Switch Settings Item Uplink Client Sampling 
- Uplink client sampling
- useCombined booleanPower 
- The use Combined Power as the default behavior of secondary power supplies on supported devices.
- vlan number
- Management VLAN
- mac_blocklist GetSwitch Settings Item Mac Blocklist 
- MAC blocklist
- power_exceptions Sequence[GetSwitch Settings Item Power Exception] 
- Exceptions on a per switch basis to "useCombinedPower"
- uplink_client_ Getsampling Switch Settings Item Uplink Client Sampling 
- Uplink client sampling
- use_combined_ boolpower 
- The use Combined Power as the default behavior of secondary power supplies on supported devices.
- vlan int
- Management VLAN
- macBlocklist Property Map
- MAC blocklist
- powerExceptions List<Property Map>
- Exceptions on a per switch basis to "useCombinedPower"
- uplinkClient Property MapSampling 
- Uplink client sampling
- useCombined BooleanPower 
- The use Combined Power as the default behavior of secondary power supplies on supported devices.
- vlan Number
- Management VLAN
GetSwitchSettingsItemMacBlocklist     
- Enabled bool
- Enable MAC blocklist for switches in the network
- Enabled bool
- Enable MAC blocklist for switches in the network
- enabled Boolean
- Enable MAC blocklist for switches in the network
- enabled boolean
- Enable MAC blocklist for switches in the network
- enabled bool
- Enable MAC blocklist for switches in the network
- enabled Boolean
- Enable MAC blocklist for switches in the network
GetSwitchSettingsItemPowerException     
- power_type str
- Per switch exception (combined, redundant, useNetworkSetting)
- serial str
- Serial number of the switch
GetSwitchSettingsItemUplinkClientSampling      
- Enabled bool
- Enable client sampling on uplink
- Enabled bool
- Enable client sampling on uplink
- enabled Boolean
- Enable client sampling on uplink
- enabled boolean
- Enable client sampling on uplink
- enabled bool
- Enable client sampling on uplink
- enabled Boolean
- Enable client sampling on uplink
Package Details
- Repository
- meraki pulumi/pulumi-meraki
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the merakiTerraform Provider.
