Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortios
  3. API Docs
  4. switchcontroller
  5. Stpsettings
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

fortios.switchcontroller.Stpsettings

Explore with Pulumi AI

fortios logo
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

    Configure FortiSwitch spanning tree protocol (STP).

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as fortios from "@pulumiverse/fortios";

const trname = new fortios.switchcontroller.Stpsettings("trname", {
    forwardTime: 15,
    helloTime: 2,
    maxAge: 20,
    maxHops: 20,
    pendingTimer: 4,
    revision: 0,
    status: "enable",
});

    import pulumi
import pulumiverse_fortios as fortios

trname = fortios.switchcontroller.Stpsettings("trname",
    forward_time=15,
    hello_time=2,
    max_age=20,
    max_hops=20,
    pending_timer=4,
    revision=0,
    status="enable")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-fortios/sdk/go/fortios/switchcontroller"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := switchcontroller.NewStpsettings(ctx, "trname", &switchcontroller.StpsettingsArgs{
			ForwardTime:  pulumi.Int(15),
			HelloTime:    pulumi.Int(2),
			MaxAge:       pulumi.Int(20),
			MaxHops:      pulumi.Int(20),
			PendingTimer: pulumi.Int(4),
			Revision:     pulumi.Int(0),
			Status:       pulumi.String("enable"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortios = Pulumiverse.Fortios;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortios.Switchcontroller.Stpsettings("trname", new()
    {
        ForwardTime = 15,
        HelloTime = 2,
        MaxAge = 20,
        MaxHops = 20,
        PendingTimer = 4,
        Revision = 0,
        Status = "enable",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.switchcontroller.Stpsettings;
import com.pulumi.fortios.switchcontroller.StpsettingsArgs;
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 trname = new Stpsettings("trname", StpsettingsArgs.builder()
            .forwardTime(15)
            .helloTime(2)
            .maxAge(20)
            .maxHops(20)
            .pendingTimer(4)
            .revision(0)
            .status("enable")
            .build());

    }
}

    resources:
  trname:
    type: fortios:switchcontroller:Stpsettings
    properties:
      forwardTime: 15
      helloTime: 2
      maxAge: 20
      maxHops: 20
      pendingTimer: 4
      revision: 0
      status: enable

    Create Stpsettings Resource

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

    Constructor syntax

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

@overload
def Stpsettings(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                forward_time: Optional[int] = None,
                hello_time: Optional[int] = None,
                max_age: Optional[int] = None,
                max_hops: Optional[int] = None,
                name: Optional[str] = None,
                pending_timer: Optional[int] = None,
                revision: Optional[int] = None,
                status: Optional[str] = None,
                vdomparam: Optional[str] = None)
    func NewStpsettings(ctx *Context, name string, args *StpsettingsArgs, opts ...ResourceOption) (*Stpsettings, error)
    public Stpsettings(string name, StpsettingsArgs? args = null, CustomResourceOptions? opts = null)
    public Stpsettings(String name, StpsettingsArgs args)
public Stpsettings(String name, StpsettingsArgs args, CustomResourceOptions options)

    type: fortios:switchcontroller:Stpsettings
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 StpsettingsArgs
    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 StpsettingsArgs
    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 StpsettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StpsettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StpsettingsArgs
    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 stpsettingsResource = new Fortios.Switchcontroller.Stpsettings("stpsettingsResource", new()
{
    ForwardTime = 0,
    HelloTime = 0,
    MaxAge = 0,
    MaxHops = 0,
    Name = "string",
    PendingTimer = 0,
    Revision = 0,
    Status = "string",
    Vdomparam = "string",
});

    example, err := switchcontroller.NewStpsettings(ctx, "stpsettingsResource", &switchcontroller.StpsettingsArgs{
	ForwardTime:  pulumi.Int(0),
	HelloTime:    pulumi.Int(0),
	MaxAge:       pulumi.Int(0),
	MaxHops:      pulumi.Int(0),
	Name:         pulumi.String("string"),
	PendingTimer: pulumi.Int(0),
	Revision:     pulumi.Int(0),
	Status:       pulumi.String("string"),
	Vdomparam:    pulumi.String("string"),
})

    var stpsettingsResource = new Stpsettings("stpsettingsResource", StpsettingsArgs.builder()
    .forwardTime(0)
    .helloTime(0)
    .maxAge(0)
    .maxHops(0)
    .name("string")
    .pendingTimer(0)
    .revision(0)
    .status("string")
    .vdomparam("string")
    .build());

    stpsettings_resource = fortios.switchcontroller.Stpsettings("stpsettingsResource",
    forward_time=0,
    hello_time=0,
    max_age=0,
    max_hops=0,
    name="string",
    pending_timer=0,
    revision=0,
    status="string",
    vdomparam="string")

    const stpsettingsResource = new fortios.switchcontroller.Stpsettings("stpsettingsResource", {
    forwardTime: 0,
    helloTime: 0,
    maxAge: 0,
    maxHops: 0,
    name: "string",
    pendingTimer: 0,
    revision: 0,
    status: "string",
    vdomparam: "string",
});

    type: fortios:switchcontroller:Stpsettings
properties:
    forwardTime: 0
    helloTime: 0
    maxAge: 0
    maxHops: 0
    name: string
    pendingTimer: 0
    revision: 0
    status: string
    vdomparam: string

    Stpsettings Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Stpsettings resource accepts the following input properties:

    ForwardTime int
    Period of time a port is in listening and learning state (4 - 30 sec, default = 15).
    HelloTime int
    Period of time between successive STP frame Bridge Protocol Data Units (BPDUs) sent on a port (1 - 10 sec, default = 2).
    MaxAge int
    Maximum time before a bridge port expires its configuration BPDU information (6 - 40 sec, default = 20).
    MaxHops int
    Maximum number of hops between the root bridge and the furthest bridge (1- 40, default = 20).
    Name string
    Name of global STP settings configuration.
    PendingTimer int
    Pending time (1 - 15 sec, default = 4).
    Revision int
    STP revision number (0 - 65535).
    Status string
    Enable/disable STP. Valid values: enable, disable.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    ForwardTime int
    Period of time a port is in listening and learning state (4 - 30 sec, default = 15).
    HelloTime int
    Period of time between successive STP frame Bridge Protocol Data Units (BPDUs) sent on a port (1 - 10 sec, default = 2).
    MaxAge int
    Maximum time before a bridge port expires its configuration BPDU information (6 - 40 sec, default = 20).
    MaxHops int
    Maximum number of hops between the root bridge and the furthest bridge (1- 40, default = 20).
    Name string
    Name of global STP settings configuration.
    PendingTimer int
    Pending time (1 - 15 sec, default = 4).
    Revision int
    STP revision number (0 - 65535).
    Status string
    Enable/disable STP. Valid values: enable, disable.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    forwardTime Integer
    Period of time a port is in listening and learning state (4 - 30 sec, default = 15).
    helloTime Integer
    Period of time between successive STP frame Bridge Protocol Data Units (BPDUs) sent on a port (1 - 10 sec, default = 2).
    maxAge Integer
    Maximum time before a bridge port expires its configuration BPDU information (6 - 40 sec, default = 20).
    maxHops Integer
    Maximum number of hops between the root bridge and the furthest bridge (1- 40, default = 20).
    name String
    Name of global STP settings configuration.
    pendingTimer Integer
    Pending time (1 - 15 sec, default = 4).
    revision Integer
    STP revision number (0 - 65535).
    status String
    Enable/disable STP. Valid values: enable, disable.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    forwardTime number
    Period of time a port is in listening and learning state (4 - 30 sec, default = 15).
    helloTime number
    Period of time between successive STP frame Bridge Protocol Data Units (BPDUs) sent on a port (1 - 10 sec, default = 2).
    maxAge number
    Maximum time before a bridge port expires its configuration BPDU information (6 - 40 sec, default = 20).
    maxHops number
    Maximum number of hops between the root bridge and the furthest bridge (1- 40, default = 20).
    name string
    Name of global STP settings configuration.
    pendingTimer number
    Pending time (1 - 15 sec, default = 4).
    revision number
    STP revision number (0 - 65535).
    status string
    Enable/disable STP. Valid values: enable, disable.
    vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    forward_time int
    Period of time a port is in listening and learning state (4 - 30 sec, default = 15).
    hello_time int
    Period of time between successive STP frame Bridge Protocol Data Units (BPDUs) sent on a port (1 - 10 sec, default = 2).
    max_age int
    Maximum time before a bridge port expires its configuration BPDU information (6 - 40 sec, default = 20).
    max_hops int
    Maximum number of hops between the root bridge and the furthest bridge (1- 40, default = 20).
    name str
    Name of global STP settings configuration.
    pending_timer int
    Pending time (1 - 15 sec, default = 4).
    revision int
    STP revision number (0 - 65535).
    status str
    Enable/disable STP. Valid values: enable, disable.
    vdomparam str
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    forwardTime Number
    Period of time a port is in listening and learning state (4 - 30 sec, default = 15).
    helloTime Number
    Period of time between successive STP frame Bridge Protocol Data Units (BPDUs) sent on a port (1 - 10 sec, default = 2).
    maxAge Number
    Maximum time before a bridge port expires its configuration BPDU information (6 - 40 sec, default = 20).
    maxHops Number
    Maximum number of hops between the root bridge and the furthest bridge (1- 40, default = 20).
    name String
    Name of global STP settings configuration.
    pendingTimer Number
    Pending time (1 - 15 sec, default = 4).
    revision Number
    STP revision number (0 - 65535).
    status String
    Enable/disable STP. Valid values: enable, disable.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Stpsettings 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 Stpsettings Resource

    Get an existing Stpsettings 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?: StpsettingsState, opts?: CustomResourceOptions): Stpsettings
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        forward_time: Optional[int] = None,
        hello_time: Optional[int] = None,
        max_age: Optional[int] = None,
        max_hops: Optional[int] = None,
        name: Optional[str] = None,
        pending_timer: Optional[int] = None,
        revision: Optional[int] = None,
        status: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Stpsettings
    func GetStpsettings(ctx *Context, name string, id IDInput, state *StpsettingsState, opts ...ResourceOption) (*Stpsettings, error)
    public static Stpsettings Get(string name, Input<string> id, StpsettingsState? state, CustomResourceOptions? opts = null)
    public static Stpsettings get(String name, Output<String> id, StpsettingsState 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:
    ForwardTime int
    Period of time a port is in listening and learning state (4 - 30 sec, default = 15).
    HelloTime int
    Period of time between successive STP frame Bridge Protocol Data Units (BPDUs) sent on a port (1 - 10 sec, default = 2).
    MaxAge int
    Maximum time before a bridge port expires its configuration BPDU information (6 - 40 sec, default = 20).
    MaxHops int
    Maximum number of hops between the root bridge and the furthest bridge (1- 40, default = 20).
    Name string
    Name of global STP settings configuration.
    PendingTimer int
    Pending time (1 - 15 sec, default = 4).
    Revision int
    STP revision number (0 - 65535).
    Status string
    Enable/disable STP. Valid values: enable, disable.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    ForwardTime int
    Period of time a port is in listening and learning state (4 - 30 sec, default = 15).
    HelloTime int
    Period of time between successive STP frame Bridge Protocol Data Units (BPDUs) sent on a port (1 - 10 sec, default = 2).
    MaxAge int
    Maximum time before a bridge port expires its configuration BPDU information (6 - 40 sec, default = 20).
    MaxHops int
    Maximum number of hops between the root bridge and the furthest bridge (1- 40, default = 20).
    Name string
    Name of global STP settings configuration.
    PendingTimer int
    Pending time (1 - 15 sec, default = 4).
    Revision int
    STP revision number (0 - 65535).
    Status string
    Enable/disable STP. Valid values: enable, disable.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    forwardTime Integer
    Period of time a port is in listening and learning state (4 - 30 sec, default = 15).
    helloTime Integer
    Period of time between successive STP frame Bridge Protocol Data Units (BPDUs) sent on a port (1 - 10 sec, default = 2).
    maxAge Integer
    Maximum time before a bridge port expires its configuration BPDU information (6 - 40 sec, default = 20).
    maxHops Integer
    Maximum number of hops between the root bridge and the furthest bridge (1- 40, default = 20).
    name String
    Name of global STP settings configuration.
    pendingTimer Integer
    Pending time (1 - 15 sec, default = 4).
    revision Integer
    STP revision number (0 - 65535).
    status String
    Enable/disable STP. Valid values: enable, disable.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    forwardTime number
    Period of time a port is in listening and learning state (4 - 30 sec, default = 15).
    helloTime number
    Period of time between successive STP frame Bridge Protocol Data Units (BPDUs) sent on a port (1 - 10 sec, default = 2).
    maxAge number
    Maximum time before a bridge port expires its configuration BPDU information (6 - 40 sec, default = 20).
    maxHops number
    Maximum number of hops between the root bridge and the furthest bridge (1- 40, default = 20).
    name string
    Name of global STP settings configuration.
    pendingTimer number
    Pending time (1 - 15 sec, default = 4).
    revision number
    STP revision number (0 - 65535).
    status string
    Enable/disable STP. Valid values: enable, disable.
    vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    forward_time int
    Period of time a port is in listening and learning state (4 - 30 sec, default = 15).
    hello_time int
    Period of time between successive STP frame Bridge Protocol Data Units (BPDUs) sent on a port (1 - 10 sec, default = 2).
    max_age int
    Maximum time before a bridge port expires its configuration BPDU information (6 - 40 sec, default = 20).
    max_hops int
    Maximum number of hops between the root bridge and the furthest bridge (1- 40, default = 20).
    name str
    Name of global STP settings configuration.
    pending_timer int
    Pending time (1 - 15 sec, default = 4).
    revision int
    STP revision number (0 - 65535).
    status str
    Enable/disable STP. Valid values: enable, disable.
    vdomparam str
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    forwardTime Number
    Period of time a port is in listening and learning state (4 - 30 sec, default = 15).
    helloTime Number
    Period of time between successive STP frame Bridge Protocol Data Units (BPDUs) sent on a port (1 - 10 sec, default = 2).
    maxAge Number
    Maximum time before a bridge port expires its configuration BPDU information (6 - 40 sec, default = 20).
    maxHops Number
    Maximum number of hops between the root bridge and the furthest bridge (1- 40, default = 20).
    name String
    Name of global STP settings configuration.
    pendingTimer Number
    Pending time (1 - 15 sec, default = 4).
    revision Number
    STP revision number (0 - 65535).
    status String
    Enable/disable STP. Valid values: enable, disable.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

    Import

    SwitchController StpSettings can be imported using any of these accepted formats:

    $ pulumi import fortios:switchcontroller/stpsettings:Stpsettings labelname SwitchControllerStpSettings

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:switchcontroller/stpsettings:Stpsettings labelname SwitchControllerStpSettings

    $ unset “FORTIOS_IMPORT_TABLE”

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

    Package Details

    Repository
    fortios pulumiverse/pulumi-fortios
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the fortios Terraform Provider.
    fortios logo
    Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
    pulumiverse/pulumi-fortios