Docs Packages
  1. Packages
  2. Cisco Meraki
  3. API Docs
  4. networks
  5. SwitchStp
Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi
pulumi/pulumi-meraki

meraki.networks.SwitchStp

Explore with Pulumi AI

meraki logo
Cisco Meraki v0.2.4 published on Friday, Jun 14, 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.SwitchStp;
import com.pulumi.meraki.networks.SwitchStpArgs;
import com.pulumi.meraki.networks.inputs.SwitchStpStpBridgePriorityArgs;
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 SwitchStp("example", SwitchStpArgs.builder()
            .networkId("string")
            .rstpEnabled(true)
            .stpBridgePriorities(SwitchStpStpBridgePriorityArgs.builder()
                .stp_priority(4096)
                .switches(                
                    "Q234-ABCD-0001",
                    "Q234-ABCD-0002",
                    "Q234-ABCD-0003")
                .build())
            .build());

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

    resources:
  example:
    type: meraki:networks:SwitchStp
    properties:
      networkId: string
      rstpEnabled: true
      stpBridgePriorities:
        - stp_priority: 4096
          switches:
            - Q234-ABCD-0001
            - Q234-ABCD-0002
            - Q234-ABCD-0003
outputs:
  merakiNetworksSwitchStpExample: ${example}

    Create SwitchStp Resource

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

    Constructor syntax

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

@overload
def SwitchStp(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              network_id: Optional[str] = None,
              rstp_enabled: Optional[bool] = None,
              stp_bridge_priorities: Optional[Sequence[SwitchStpStpBridgePriorityArgs]] = None)
    func NewSwitchStp(ctx *Context, name string, args SwitchStpArgs, opts ...ResourceOption) (*SwitchStp, error)
    public SwitchStp(string name, SwitchStpArgs args, CustomResourceOptions? opts = null)
    public SwitchStp(String name, SwitchStpArgs args)
public SwitchStp(String name, SwitchStpArgs args, CustomResourceOptions options)

    type: meraki:networks:SwitchStp
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 SwitchStpArgs
    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 SwitchStpArgs
    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 SwitchStpArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SwitchStpArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SwitchStpArgs
    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 switchStpResource = new Meraki.Networks.SwitchStp("switchStpResource", new()
{
    NetworkId = "string",
    RstpEnabled = false,
    StpBridgePriorities = new[]
    {
        new Meraki.Networks.Inputs.SwitchStpStpBridgePriorityArgs
        {
            Stacks = new[]
            {
                "string",
            },
            StpPriority = 0,
            SwitchProfiles = new[]
            {
                "string",
            },
            Switches = new[]
            {
                "string",
            },
        },
    },
});

    example, err := networks.NewSwitchStp(ctx, "switchStpResource", &networks.SwitchStpArgs{
	NetworkId:   pulumi.String("string"),
	RstpEnabled: pulumi.Bool(false),
	StpBridgePriorities: networks.SwitchStpStpBridgePriorityArray{
		&networks.SwitchStpStpBridgePriorityArgs{
			Stacks: pulumi.StringArray{
				pulumi.String("string"),
			},
			StpPriority: pulumi.Int(0),
			SwitchProfiles: pulumi.StringArray{
				pulumi.String("string"),
			},
			Switches: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
})

    var switchStpResource = new SwitchStp("switchStpResource", SwitchStpArgs.builder()
    .networkId("string")
    .rstpEnabled(false)
    .stpBridgePriorities(SwitchStpStpBridgePriorityArgs.builder()
        .stacks("string")
        .stpPriority(0)
        .switchProfiles("string")
        .switches("string")
        .build())
    .build());

    switch_stp_resource = meraki.networks.SwitchStp("switchStpResource",
    network_id="string",
    rstp_enabled=False,
    stp_bridge_priorities=[meraki.networks.SwitchStpStpBridgePriorityArgs(
        stacks=["string"],
        stp_priority=0,
        switch_profiles=["string"],
        switches=["string"],
    )])

    const switchStpResource = new meraki.networks.SwitchStp("switchStpResource", {
    networkId: "string",
    rstpEnabled: false,
    stpBridgePriorities: [{
        stacks: ["string"],
        stpPriority: 0,
        switchProfiles: ["string"],
        switches: ["string"],
    }],
});

    type: meraki:networks:SwitchStp
properties:
    networkId: string
    rstpEnabled: false
    stpBridgePriorities:
        - stacks:
            - string
          stpPriority: 0
          switchProfiles:
            - string
          switches:
            - string

    SwitchStp 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 SwitchStp resource accepts the following input properties:

    NetworkId string
    networkId path parameter. Network ID
    RstpEnabled bool
    The spanning tree protocol status in network
    StpBridgePriorities List<SwitchStpStpBridgePriority>
    STP bridge priority for switches/stacks or switch templates. An empty array will clear the STP bridge priority settings.
    NetworkId string
    networkId path parameter. Network ID
    RstpEnabled bool
    The spanning tree protocol status in network
    StpBridgePriorities []SwitchStpStpBridgePriorityArgs
    STP bridge priority for switches/stacks or switch templates. An empty array will clear the STP bridge priority settings.
    networkId String
    networkId path parameter. Network ID
    rstpEnabled Boolean
    The spanning tree protocol status in network
    stpBridgePriorities List<SwitchStpStpBridgePriority>
    STP bridge priority for switches/stacks or switch templates. An empty array will clear the STP bridge priority settings.
    networkId string
    networkId path parameter. Network ID
    rstpEnabled boolean
    The spanning tree protocol status in network
    stpBridgePriorities SwitchStpStpBridgePriority[]
    STP bridge priority for switches/stacks or switch templates. An empty array will clear the STP bridge priority settings.
    network_id str
    networkId path parameter. Network ID
    rstp_enabled bool
    The spanning tree protocol status in network
    stp_bridge_priorities Sequence[SwitchStpStpBridgePriorityArgs]
    STP bridge priority for switches/stacks or switch templates. An empty array will clear the STP bridge priority settings.
    networkId String
    networkId path parameter. Network ID
    rstpEnabled Boolean
    The spanning tree protocol status in network
    stpBridgePriorities List<Property Map>
    STP bridge priority for switches/stacks or switch templates. An empty array will clear the STP bridge priority settings.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    StpBridgePriorityResponses List<SwitchStpStpBridgePriorityResponse>
    STP bridge priority for switches/stacks or switch templates. An empty array will clear the STP bridge priority settings.
    Id string
    The provider-assigned unique ID for this managed resource.
    StpBridgePriorityResponses []SwitchStpStpBridgePriorityResponse
    STP bridge priority for switches/stacks or switch templates. An empty array will clear the STP bridge priority settings.
    id String
    The provider-assigned unique ID for this managed resource.
    stpBridgePriorityResponses List<SwitchStpStpBridgePriorityResponse>
    STP bridge priority for switches/stacks or switch templates. An empty array will clear the STP bridge priority settings.
    id string
    The provider-assigned unique ID for this managed resource.
    stpBridgePriorityResponses SwitchStpStpBridgePriorityResponse[]
    STP bridge priority for switches/stacks or switch templates. An empty array will clear the STP bridge priority settings.
    id str
    The provider-assigned unique ID for this managed resource.
    stp_bridge_priority_responses Sequence[SwitchStpStpBridgePriorityResponse]
    STP bridge priority for switches/stacks or switch templates. An empty array will clear the STP bridge priority settings.
    id String
    The provider-assigned unique ID for this managed resource.
    stpBridgePriorityResponses List<Property Map>
    STP bridge priority for switches/stacks or switch templates. An empty array will clear the STP bridge priority settings.

    Look up Existing SwitchStp Resource

    Get an existing SwitchStp 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?: SwitchStpState, opts?: CustomResourceOptions): SwitchStp
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        network_id: Optional[str] = None,
        rstp_enabled: Optional[bool] = None,
        stp_bridge_priorities: Optional[Sequence[SwitchStpStpBridgePriorityArgs]] = None,
        stp_bridge_priority_responses: Optional[Sequence[SwitchStpStpBridgePriorityResponseArgs]] = None) -> SwitchStp
    func GetSwitchStp(ctx *Context, name string, id IDInput, state *SwitchStpState, opts ...ResourceOption) (*SwitchStp, error)
    public static SwitchStp Get(string name, Input<string> id, SwitchStpState? state, CustomResourceOptions? opts = null)
    public static SwitchStp get(String name, Output<String> id, SwitchStpState 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:
    NetworkId string
    networkId path parameter. Network ID
    RstpEnabled bool
    The spanning tree protocol status in network
    StpBridgePriorities List<SwitchStpStpBridgePriority>
    STP bridge priority for switches/stacks or switch templates. An empty array will clear the STP bridge priority settings.
    StpBridgePriorityResponses List<SwitchStpStpBridgePriorityResponse>
    STP bridge priority for switches/stacks or switch templates. An empty array will clear the STP bridge priority settings.
    NetworkId string
    networkId path parameter. Network ID
    RstpEnabled bool
    The spanning tree protocol status in network
    StpBridgePriorities []SwitchStpStpBridgePriorityArgs
    STP bridge priority for switches/stacks or switch templates. An empty array will clear the STP bridge priority settings.
    StpBridgePriorityResponses []SwitchStpStpBridgePriorityResponseArgs
    STP bridge priority for switches/stacks or switch templates. An empty array will clear the STP bridge priority settings.
    networkId String
    networkId path parameter. Network ID
    rstpEnabled Boolean
    The spanning tree protocol status in network
    stpBridgePriorities List<SwitchStpStpBridgePriority>
    STP bridge priority for switches/stacks or switch templates. An empty array will clear the STP bridge priority settings.
    stpBridgePriorityResponses List<SwitchStpStpBridgePriorityResponse>
    STP bridge priority for switches/stacks or switch templates. An empty array will clear the STP bridge priority settings.
    networkId string
    networkId path parameter. Network ID
    rstpEnabled boolean
    The spanning tree protocol status in network
    stpBridgePriorities SwitchStpStpBridgePriority[]
    STP bridge priority for switches/stacks or switch templates. An empty array will clear the STP bridge priority settings.
    stpBridgePriorityResponses SwitchStpStpBridgePriorityResponse[]
    STP bridge priority for switches/stacks or switch templates. An empty array will clear the STP bridge priority settings.
    network_id str
    networkId path parameter. Network ID
    rstp_enabled bool
    The spanning tree protocol status in network
    stp_bridge_priorities Sequence[SwitchStpStpBridgePriorityArgs]
    STP bridge priority for switches/stacks or switch templates. An empty array will clear the STP bridge priority settings.
    stp_bridge_priority_responses Sequence[SwitchStpStpBridgePriorityResponseArgs]
    STP bridge priority for switches/stacks or switch templates. An empty array will clear the STP bridge priority settings.
    networkId String
    networkId path parameter. Network ID
    rstpEnabled Boolean
    The spanning tree protocol status in network
    stpBridgePriorities List<Property Map>
    STP bridge priority for switches/stacks or switch templates. An empty array will clear the STP bridge priority settings.
    stpBridgePriorityResponses List<Property Map>
    STP bridge priority for switches/stacks or switch templates. An empty array will clear the STP bridge priority settings.

    Supporting Types

    SwitchStpStpBridgePriority, SwitchStpStpBridgePriorityArgs

    Stacks List<string>
    List of stack IDs
    StpPriority int
    STP priority for switch, stacks, or switch profiles
    SwitchProfiles List<string>
    List of switch profile IDs
    Switches List<string>
    List of switch serial numbers
    Stacks []string
    List of stack IDs
    StpPriority int
    STP priority for switch, stacks, or switch profiles
    SwitchProfiles []string
    List of switch profile IDs
    Switches []string
    List of switch serial numbers
    stacks List<String>
    List of stack IDs
    stpPriority Integer
    STP priority for switch, stacks, or switch profiles
    switchProfiles List<String>
    List of switch profile IDs
    switches List<String>
    List of switch serial numbers
    stacks string[]
    List of stack IDs
    stpPriority number
    STP priority for switch, stacks, or switch profiles
    switchProfiles string[]
    List of switch profile IDs
    switches string[]
    List of switch serial numbers
    stacks Sequence[str]
    List of stack IDs
    stp_priority int
    STP priority for switch, stacks, or switch profiles
    switch_profiles Sequence[str]
    List of switch profile IDs
    switches Sequence[str]
    List of switch serial numbers
    stacks List<String>
    List of stack IDs
    stpPriority Number
    STP priority for switch, stacks, or switch profiles
    switchProfiles List<String>
    List of switch profile IDs
    switches List<String>
    List of switch serial numbers

    SwitchStpStpBridgePriorityResponse, SwitchStpStpBridgePriorityResponseArgs

    Stacks List<string>
    List of stack IDs
    StpPriority int
    STP priority for switch, stacks, or switch templates
    SwitchProfiles List<string>
    List of switch template IDs
    Switches List<string>
    List of switch serial numbers
    Stacks []string
    List of stack IDs
    StpPriority int
    STP priority for switch, stacks, or switch templates
    SwitchProfiles []string
    List of switch template IDs
    Switches []string
    List of switch serial numbers
    stacks List<String>
    List of stack IDs
    stpPriority Integer
    STP priority for switch, stacks, or switch templates
    switchProfiles List<String>
    List of switch template IDs
    switches List<String>
    List of switch serial numbers
    stacks string[]
    List of stack IDs
    stpPriority number
    STP priority for switch, stacks, or switch templates
    switchProfiles string[]
    List of switch template IDs
    switches string[]
    List of switch serial numbers
    stacks Sequence[str]
    List of stack IDs
    stp_priority int
    STP priority for switch, stacks, or switch templates
    switch_profiles Sequence[str]
    List of switch template IDs
    switches Sequence[str]
    List of switch serial numbers
    stacks List<String>
    List of stack IDs
    stpPriority Number
    STP priority for switch, stacks, or switch templates
    switchProfiles List<String>
    List of switch template IDs
    switches List<String>
    List of switch serial numbers

    Import

    $ pulumi import meraki:networks/switchStp:SwitchStp 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.2.4 published on Friday, Jun 14, 2024 by Pulumi
    pulumi/pulumi-meraki