Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Meraki Provider
  3. API Docs
  4. networks
  5. SwitchSettings
Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-meraki

meraki.networks.SwitchSettings

Explore with Pulumi AI

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

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.meraki.networks.SwitchSettings;
import com.pulumi.meraki.networks.SwitchSettingsArgs;
import com.pulumi.meraki.networks.inputs.SwitchSettingsMacBlocklistArgs;
import com.pulumi.meraki.networks.inputs.SwitchSettingsPowerExceptionArgs;
import com.pulumi.meraki.networks.inputs.SwitchSettingsUplinkClientSamplingArgs;
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) {
        var example = new SwitchSettings("example", SwitchSettingsArgs.builder()
            .macBlocklist(SwitchSettingsMacBlocklistArgs.builder()
                .enabled(false)
                .build())
            .networkId("string")
            .powerExceptions(SwitchSettingsPowerExceptionArgs.builder()
                .power_type("string")
                .serial("string")
                .build())
            .uplinkClientSampling(SwitchSettingsUplinkClientSamplingArgs.builder()
                .enabled(false)
                .build())
            .useCombinedPower(false)
            .vlan(1)
            .build());

        ctx.export("merakiNetworksSwitchSettingsExample", example);
    }
}

    resources:
  example:
    type: meraki:networks:SwitchSettings
    properties:
      macBlocklist:
        enabled: false
      networkId: string
      powerExceptions:
        - power_type: string
          serial: string
      uplinkClientSampling:
        enabled: false
      useCombinedPower: false
      vlan: 1
outputs:
  merakiNetworksSwitchSettingsExample: ${example}

    Create SwitchSettings Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SwitchSettings(name: string, args: SwitchSettingsArgs, opts?: CustomResourceOptions);
    @overload
def SwitchSettings(resource_name: str,
                   args: SwitchSettingsArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def SwitchSettings(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   network_id: Optional[str] = None,
                   mac_blocklist: Optional[SwitchSettingsMacBlocklistArgs] = None,
                   power_exceptions: Optional[Sequence[SwitchSettingsPowerExceptionArgs]] = None,
                   uplink_client_sampling: Optional[SwitchSettingsUplinkClientSamplingArgs] = None,
                   use_combined_power: Optional[bool] = None,
                   vlan: Optional[int] = None)
    func NewSwitchSettings(ctx *Context, name string, args SwitchSettingsArgs, opts ...ResourceOption) (*SwitchSettings, error)
    public SwitchSettings(string name, SwitchSettingsArgs args, CustomResourceOptions? opts = null)
    public SwitchSettings(String name, SwitchSettingsArgs args)
public SwitchSettings(String name, SwitchSettingsArgs args, CustomResourceOptions options)

    type: meraki:networks:SwitchSettings
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SwitchSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SwitchSettingsArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SwitchSettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SwitchSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SwitchSettingsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var switchSettingsResource = new Meraki.Networks.SwitchSettings("switchSettingsResource", new()
{
    NetworkId = "string",
    MacBlocklist = new Meraki.Networks.Inputs.SwitchSettingsMacBlocklistArgs
    {
        Enabled = false,
    },
    PowerExceptions = new[]
    {
        new Meraki.Networks.Inputs.SwitchSettingsPowerExceptionArgs
        {
            PowerType = "string",
            Serial = "string",
        },
    },
    UplinkClientSampling = new Meraki.Networks.Inputs.SwitchSettingsUplinkClientSamplingArgs
    {
        Enabled = false,
    },
    UseCombinedPower = false,
    Vlan = 0,
});

    example, err := networks.NewSwitchSettings(ctx, "switchSettingsResource", &networks.SwitchSettingsArgs{
	NetworkId: pulumi.String("string"),
	MacBlocklist: &networks.SwitchSettingsMacBlocklistArgs{
		Enabled: pulumi.Bool(false),
	},
	PowerExceptions: networks.SwitchSettingsPowerExceptionArray{
		&networks.SwitchSettingsPowerExceptionArgs{
			PowerType: pulumi.String("string"),
			Serial:    pulumi.String("string"),
		},
	},
	UplinkClientSampling: &networks.SwitchSettingsUplinkClientSamplingArgs{
		Enabled: pulumi.Bool(false),
	},
	UseCombinedPower: pulumi.Bool(false),
	Vlan:             pulumi.Int(0),
})

    var switchSettingsResource = new SwitchSettings("switchSettingsResource", SwitchSettingsArgs.builder()
    .networkId("string")
    .macBlocklist(SwitchSettingsMacBlocklistArgs.builder()
        .enabled(false)
        .build())
    .powerExceptions(SwitchSettingsPowerExceptionArgs.builder()
        .powerType("string")
        .serial("string")
        .build())
    .uplinkClientSampling(SwitchSettingsUplinkClientSamplingArgs.builder()
        .enabled(false)
        .build())
    .useCombinedPower(false)
    .vlan(0)
    .build());

    switch_settings_resource = meraki.networks.SwitchSettings("switchSettingsResource",
    network_id="string",
    mac_blocklist=meraki.networks.SwitchSettingsMacBlocklistArgs(
        enabled=False,
    ),
    power_exceptions=[meraki.networks.SwitchSettingsPowerExceptionArgs(
        power_type="string",
        serial="string",
    )],
    uplink_client_sampling=meraki.networks.SwitchSettingsUplinkClientSamplingArgs(
        enabled=False,
    ),
    use_combined_power=False,
    vlan=0)

    const switchSettingsResource = new meraki.networks.SwitchSettings("switchSettingsResource", {
    networkId: "string",
    macBlocklist: {
        enabled: false,
    },
    powerExceptions: [{
        powerType: "string",
        serial: "string",
    }],
    uplinkClientSampling: {
        enabled: false,
    },
    useCombinedPower: false,
    vlan: 0,
});

    type: meraki:networks:SwitchSettings
properties:
    macBlocklist:
        enabled: false
    networkId: string
    powerExceptions:
        - powerType: string
          serial: string
    uplinkClientSampling:
        enabled: false
    useCombinedPower: false
    vlan: 0

    SwitchSettings Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The SwitchSettings resource accepts the following input properties:

    NetworkId string
    networkId path parameter. Network ID
    MacBlocklist SwitchSettingsMacBlocklist
    MAC blocklist
    PowerExceptions List<SwitchSettingsPowerException>
    Exceptions on a per switch basis to "useCombinedPower"
    UplinkClientSampling SwitchSettingsUplinkClientSampling
    Uplink client sampling
    UseCombinedPower bool
    The use Combined Power as the default behavior of secondary power supplies on supported devices.
    Vlan int
    Management VLAN
    NetworkId string
    networkId path parameter. Network ID
    MacBlocklist SwitchSettingsMacBlocklistArgs
    MAC blocklist
    PowerExceptions []SwitchSettingsPowerExceptionArgs
    Exceptions on a per switch basis to "useCombinedPower"
    UplinkClientSampling SwitchSettingsUplinkClientSamplingArgs
    Uplink client sampling
    UseCombinedPower bool
    The use Combined Power as the default behavior of secondary power supplies on supported devices.
    Vlan int
    Management VLAN
    networkId String
    networkId path parameter. Network ID
    macBlocklist SwitchSettingsMacBlocklist
    MAC blocklist
    powerExceptions List<SwitchSettingsPowerException>
    Exceptions on a per switch basis to "useCombinedPower"
    uplinkClientSampling SwitchSettingsUplinkClientSampling
    Uplink client sampling
    useCombinedPower Boolean
    The use Combined Power as the default behavior of secondary power supplies on supported devices.
    vlan Integer
    Management VLAN
    networkId string
    networkId path parameter. Network ID
    macBlocklist SwitchSettingsMacBlocklist
    MAC blocklist
    powerExceptions SwitchSettingsPowerException[]
    Exceptions on a per switch basis to "useCombinedPower"
    uplinkClientSampling SwitchSettingsUplinkClientSampling
    Uplink client sampling
    useCombinedPower boolean
    The use Combined Power as the default behavior of secondary power supplies on supported devices.
    vlan number
    Management VLAN
    network_id str
    networkId path parameter. Network ID
    mac_blocklist SwitchSettingsMacBlocklistArgs
    MAC blocklist
    power_exceptions Sequence[SwitchSettingsPowerExceptionArgs]
    Exceptions on a per switch basis to "useCombinedPower"
    uplink_client_sampling SwitchSettingsUplinkClientSamplingArgs
    Uplink client sampling
    use_combined_power bool
    The use Combined Power as the default behavior of secondary power supplies on supported devices.
    vlan int
    Management VLAN
    networkId String
    networkId path parameter. Network ID
    macBlocklist Property Map
    MAC blocklist
    powerExceptions List<Property Map>
    Exceptions on a per switch basis to "useCombinedPower"
    uplinkClientSampling Property Map
    Uplink client sampling
    useCombinedPower Boolean
    The use Combined Power as the default behavior of secondary power supplies on supported devices.
    vlan Number
    Management VLAN

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SwitchSettings resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing SwitchSettings Resource

    Get an existing SwitchSettings resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SwitchSettingsState, opts?: CustomResourceOptions): SwitchSettings
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        mac_blocklist: Optional[SwitchSettingsMacBlocklistArgs] = None,
        network_id: Optional[str] = None,
        power_exceptions: Optional[Sequence[SwitchSettingsPowerExceptionArgs]] = None,
        uplink_client_sampling: Optional[SwitchSettingsUplinkClientSamplingArgs] = None,
        use_combined_power: Optional[bool] = None,
        vlan: Optional[int] = None) -> SwitchSettings
    func GetSwitchSettings(ctx *Context, name string, id IDInput, state *SwitchSettingsState, opts ...ResourceOption) (*SwitchSettings, error)
    public static SwitchSettings Get(string name, Input<string> id, SwitchSettingsState? state, CustomResourceOptions? opts = null)
    public static SwitchSettings get(String name, Output<String> id, SwitchSettingsState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    MacBlocklist SwitchSettingsMacBlocklist
    MAC blocklist
    NetworkId string
    networkId path parameter. Network ID
    PowerExceptions List<SwitchSettingsPowerException>
    Exceptions on a per switch basis to "useCombinedPower"
    UplinkClientSampling SwitchSettingsUplinkClientSampling
    Uplink client sampling
    UseCombinedPower bool
    The use Combined Power as the default behavior of secondary power supplies on supported devices.
    Vlan int
    Management VLAN
    MacBlocklist SwitchSettingsMacBlocklistArgs
    MAC blocklist
    NetworkId string
    networkId path parameter. Network ID
    PowerExceptions []SwitchSettingsPowerExceptionArgs
    Exceptions on a per switch basis to "useCombinedPower"
    UplinkClientSampling SwitchSettingsUplinkClientSamplingArgs
    Uplink client sampling
    UseCombinedPower bool
    The use Combined Power as the default behavior of secondary power supplies on supported devices.
    Vlan int
    Management VLAN
    macBlocklist SwitchSettingsMacBlocklist
    MAC blocklist
    networkId String
    networkId path parameter. Network ID
    powerExceptions List<SwitchSettingsPowerException>
    Exceptions on a per switch basis to "useCombinedPower"
    uplinkClientSampling SwitchSettingsUplinkClientSampling
    Uplink client sampling
    useCombinedPower Boolean
    The use Combined Power as the default behavior of secondary power supplies on supported devices.
    vlan Integer
    Management VLAN
    macBlocklist SwitchSettingsMacBlocklist
    MAC blocklist
    networkId string
    networkId path parameter. Network ID
    powerExceptions SwitchSettingsPowerException[]
    Exceptions on a per switch basis to "useCombinedPower"
    uplinkClientSampling SwitchSettingsUplinkClientSampling
    Uplink client sampling
    useCombinedPower boolean
    The use Combined Power as the default behavior of secondary power supplies on supported devices.
    vlan number
    Management VLAN
    mac_blocklist SwitchSettingsMacBlocklistArgs
    MAC blocklist
    network_id str
    networkId path parameter. Network ID
    power_exceptions Sequence[SwitchSettingsPowerExceptionArgs]
    Exceptions on a per switch basis to "useCombinedPower"
    uplink_client_sampling SwitchSettingsUplinkClientSamplingArgs
    Uplink client sampling
    use_combined_power bool
    The use Combined Power as the default behavior of secondary power supplies on supported devices.
    vlan int
    Management VLAN
    macBlocklist Property Map
    MAC blocklist
    networkId String
    networkId path parameter. Network ID
    powerExceptions List<Property Map>
    Exceptions on a per switch basis to "useCombinedPower"
    uplinkClientSampling Property Map
    Uplink client sampling
    useCombinedPower Boolean
    The use Combined Power as the default behavior of secondary power supplies on supported devices.
    vlan Number
    Management VLAN

    Supporting Types

    SwitchSettingsMacBlocklist, SwitchSettingsMacBlocklistArgs

    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

    SwitchSettingsPowerException, SwitchSettingsPowerExceptionArgs

    PowerType string
    Per switch exception (combined, redundant, useNetworkSetting)
    Serial string
    Serial number of the switch
    PowerType string
    Per switch exception (combined, redundant, useNetworkSetting)
    Serial string
    Serial number of the switch
    powerType String
    Per switch exception (combined, redundant, useNetworkSetting)
    serial String
    Serial number of the switch
    powerType string
    Per switch exception (combined, redundant, useNetworkSetting)
    serial string
    Serial number of the switch
    power_type str
    Per switch exception (combined, redundant, useNetworkSetting)
    serial str
    Serial number of the switch
    powerType String
    Per switch exception (combined, redundant, useNetworkSetting)
    serial String
    Serial number of the switch

    SwitchSettingsUplinkClientSampling, SwitchSettingsUplinkClientSamplingArgs

    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

    Import

    $ pulumi import meraki:networks/switchSettings:SwitchSettings example "network_id"

    To learn more about importing existing cloud resources, see Importing resources.

    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
    pulumi/pulumi-meraki