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

fortios.system.Stp

Explore with Pulumi AI

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

Configure Spanning Tree Protocol (STP). Applies to FortiOS Version 7.0.4.

Create Stp Resource

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

Constructor syntax

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

@overload
def Stp(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        forward_delay: Optional[int] = None,
        hello_time: Optional[int] = None,
        max_age: Optional[int] = None,
        max_hops: Optional[int] = None,
        switch_priority: Optional[str] = None,
        vdomparam: Optional[str] = None)
func NewStp(ctx *Context, name string, args *StpArgs, opts ...ResourceOption) (*Stp, error)
public Stp(string name, StpArgs? args = null, CustomResourceOptions? opts = null)
public Stp(String name, StpArgs args)
public Stp(String name, StpArgs args, CustomResourceOptions options)

type: fortios:system:Stp
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args StpArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args StpArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args StpArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args StpArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. StpArgs
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 stpResource = new Fortios.System.Stp("stpResource", new()
{
    ForwardDelay = 0,
    HelloTime = 0,
    MaxAge = 0,
    MaxHops = 0,
    SwitchPriority = "string",
    Vdomparam = "string",
});
Copy
example, err := system.NewStp(ctx, "stpResource", &system.StpArgs{
	ForwardDelay:   pulumi.Int(0),
	HelloTime:      pulumi.Int(0),
	MaxAge:         pulumi.Int(0),
	MaxHops:        pulumi.Int(0),
	SwitchPriority: pulumi.String("string"),
	Vdomparam:      pulumi.String("string"),
})
Copy
var stpResource = new Stp("stpResource", StpArgs.builder()
    .forwardDelay(0)
    .helloTime(0)
    .maxAge(0)
    .maxHops(0)
    .switchPriority("string")
    .vdomparam("string")
    .build());
Copy
stp_resource = fortios.system.Stp("stpResource",
    forward_delay=0,
    hello_time=0,
    max_age=0,
    max_hops=0,
    switch_priority="string",
    vdomparam="string")
Copy
const stpResource = new fortios.system.Stp("stpResource", {
    forwardDelay: 0,
    helloTime: 0,
    maxAge: 0,
    maxHops: 0,
    switchPriority: "string",
    vdomparam: "string",
});
Copy
type: fortios:system:Stp
properties:
    forwardDelay: 0
    helloTime: 0
    maxAge: 0
    maxHops: 0
    switchPriority: string
    vdomparam: string
Copy

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

ForwardDelay int
Forward delay (4 - 30 sec, default = 15).
HelloTime int
Hello time (1 - 10 sec, default = 2).
MaxAge int
Maximum packet age (6 - 40 sec, default = 20).
MaxHops int
Maximum number of hops (1 - 40, default = 20).
SwitchPriority string
STP switch priority; the lower the number the higher the priority (select from 0, 4096, 8192, 12288, 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, and 57344). Valid values: 0, 4096, 8192, 12288, 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344.
Vdomparam Changes to this property will trigger replacement. 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.
ForwardDelay int
Forward delay (4 - 30 sec, default = 15).
HelloTime int
Hello time (1 - 10 sec, default = 2).
MaxAge int
Maximum packet age (6 - 40 sec, default = 20).
MaxHops int
Maximum number of hops (1 - 40, default = 20).
SwitchPriority string
STP switch priority; the lower the number the higher the priority (select from 0, 4096, 8192, 12288, 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, and 57344). Valid values: 0, 4096, 8192, 12288, 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344.
Vdomparam Changes to this property will trigger replacement. 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.
forwardDelay Integer
Forward delay (4 - 30 sec, default = 15).
helloTime Integer
Hello time (1 - 10 sec, default = 2).
maxAge Integer
Maximum packet age (6 - 40 sec, default = 20).
maxHops Integer
Maximum number of hops (1 - 40, default = 20).
switchPriority String
STP switch priority; the lower the number the higher the priority (select from 0, 4096, 8192, 12288, 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, and 57344). Valid values: 0, 4096, 8192, 12288, 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344.
vdomparam Changes to this property will trigger replacement. 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.
forwardDelay number
Forward delay (4 - 30 sec, default = 15).
helloTime number
Hello time (1 - 10 sec, default = 2).
maxAge number
Maximum packet age (6 - 40 sec, default = 20).
maxHops number
Maximum number of hops (1 - 40, default = 20).
switchPriority string
STP switch priority; the lower the number the higher the priority (select from 0, 4096, 8192, 12288, 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, and 57344). Valid values: 0, 4096, 8192, 12288, 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344.
vdomparam Changes to this property will trigger replacement. 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_delay int
Forward delay (4 - 30 sec, default = 15).
hello_time int
Hello time (1 - 10 sec, default = 2).
max_age int
Maximum packet age (6 - 40 sec, default = 20).
max_hops int
Maximum number of hops (1 - 40, default = 20).
switch_priority str
STP switch priority; the lower the number the higher the priority (select from 0, 4096, 8192, 12288, 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, and 57344). Valid values: 0, 4096, 8192, 12288, 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344.
vdomparam Changes to this property will trigger replacement. 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.
forwardDelay Number
Forward delay (4 - 30 sec, default = 15).
helloTime Number
Hello time (1 - 10 sec, default = 2).
maxAge Number
Maximum packet age (6 - 40 sec, default = 20).
maxHops Number
Maximum number of hops (1 - 40, default = 20).
switchPriority String
STP switch priority; the lower the number the higher the priority (select from 0, 4096, 8192, 12288, 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, and 57344). Valid values: 0, 4096, 8192, 12288, 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344.
vdomparam Changes to this property will trigger replacement. 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 Stp 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 Stp Resource

Get an existing Stp 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?: StpState, opts?: CustomResourceOptions): Stp
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        forward_delay: Optional[int] = None,
        hello_time: Optional[int] = None,
        max_age: Optional[int] = None,
        max_hops: Optional[int] = None,
        switch_priority: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Stp
func GetStp(ctx *Context, name string, id IDInput, state *StpState, opts ...ResourceOption) (*Stp, error)
public static Stp Get(string name, Input<string> id, StpState? state, CustomResourceOptions? opts = null)
public static Stp get(String name, Output<String> id, StpState state, CustomResourceOptions options)
resources:  _:    type: fortios:system:Stp    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ForwardDelay int
Forward delay (4 - 30 sec, default = 15).
HelloTime int
Hello time (1 - 10 sec, default = 2).
MaxAge int
Maximum packet age (6 - 40 sec, default = 20).
MaxHops int
Maximum number of hops (1 - 40, default = 20).
SwitchPriority string
STP switch priority; the lower the number the higher the priority (select from 0, 4096, 8192, 12288, 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, and 57344). Valid values: 0, 4096, 8192, 12288, 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344.
Vdomparam Changes to this property will trigger replacement. 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.
ForwardDelay int
Forward delay (4 - 30 sec, default = 15).
HelloTime int
Hello time (1 - 10 sec, default = 2).
MaxAge int
Maximum packet age (6 - 40 sec, default = 20).
MaxHops int
Maximum number of hops (1 - 40, default = 20).
SwitchPriority string
STP switch priority; the lower the number the higher the priority (select from 0, 4096, 8192, 12288, 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, and 57344). Valid values: 0, 4096, 8192, 12288, 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344.
Vdomparam Changes to this property will trigger replacement. 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.
forwardDelay Integer
Forward delay (4 - 30 sec, default = 15).
helloTime Integer
Hello time (1 - 10 sec, default = 2).
maxAge Integer
Maximum packet age (6 - 40 sec, default = 20).
maxHops Integer
Maximum number of hops (1 - 40, default = 20).
switchPriority String
STP switch priority; the lower the number the higher the priority (select from 0, 4096, 8192, 12288, 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, and 57344). Valid values: 0, 4096, 8192, 12288, 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344.
vdomparam Changes to this property will trigger replacement. 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.
forwardDelay number
Forward delay (4 - 30 sec, default = 15).
helloTime number
Hello time (1 - 10 sec, default = 2).
maxAge number
Maximum packet age (6 - 40 sec, default = 20).
maxHops number
Maximum number of hops (1 - 40, default = 20).
switchPriority string
STP switch priority; the lower the number the higher the priority (select from 0, 4096, 8192, 12288, 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, and 57344). Valid values: 0, 4096, 8192, 12288, 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344.
vdomparam Changes to this property will trigger replacement. 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_delay int
Forward delay (4 - 30 sec, default = 15).
hello_time int
Hello time (1 - 10 sec, default = 2).
max_age int
Maximum packet age (6 - 40 sec, default = 20).
max_hops int
Maximum number of hops (1 - 40, default = 20).
switch_priority str
STP switch priority; the lower the number the higher the priority (select from 0, 4096, 8192, 12288, 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, and 57344). Valid values: 0, 4096, 8192, 12288, 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344.
vdomparam Changes to this property will trigger replacement. 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.
forwardDelay Number
Forward delay (4 - 30 sec, default = 15).
helloTime Number
Hello time (1 - 10 sec, default = 2).
maxAge Number
Maximum packet age (6 - 40 sec, default = 20).
maxHops Number
Maximum number of hops (1 - 40, default = 20).
switchPriority String
STP switch priority; the lower the number the higher the priority (select from 0, 4096, 8192, 12288, 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, and 57344). Valid values: 0, 4096, 8192, 12288, 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344.
vdomparam Changes to this property will trigger replacement. 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

System Stp can be imported using any of these accepted formats:

$ pulumi import fortios:system/stp:Stp labelname SystemStp
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:system/stp:Stp labelname SystemStp
Copy

$ 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 v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios