1. Packages
  2. Fortios
  3. API Docs
  4. system
  5. Switchinterface
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

fortios.system.Switchinterface

Explore with Pulumi AI

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

    Configure software switch interfaces by grouping physical and WiFi interfaces.

    Create Switchinterface Resource

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

    Constructor syntax

    new Switchinterface(name: string, args?: SwitchinterfaceArgs, opts?: CustomResourceOptions);
    @overload
    def Switchinterface(resource_name: str,
                        args: Optional[SwitchinterfaceArgs] = None,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def Switchinterface(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        dynamic_sort_subtable: Optional[str] = None,
                        get_all_tables: Optional[str] = None,
                        intra_switch_policy: Optional[str] = None,
                        mac_ttl: Optional[int] = None,
                        members: Optional[Sequence[SwitchinterfaceMemberArgs]] = None,
                        name: Optional[str] = None,
                        span: Optional[str] = None,
                        span_dest_port: Optional[str] = None,
                        span_direction: Optional[str] = None,
                        span_source_ports: Optional[Sequence[SwitchinterfaceSpanSourcePortArgs]] = None,
                        type: Optional[str] = None,
                        vdom: Optional[str] = None,
                        vdomparam: Optional[str] = None)
    func NewSwitchinterface(ctx *Context, name string, args *SwitchinterfaceArgs, opts ...ResourceOption) (*Switchinterface, error)
    public Switchinterface(string name, SwitchinterfaceArgs? args = null, CustomResourceOptions? opts = null)
    public Switchinterface(String name, SwitchinterfaceArgs args)
    public Switchinterface(String name, SwitchinterfaceArgs args, CustomResourceOptions options)
    
    type: fortios:system:Switchinterface
    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 SwitchinterfaceArgs
    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 SwitchinterfaceArgs
    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 SwitchinterfaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SwitchinterfaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SwitchinterfaceArgs
    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 switchinterfaceResource = new Fortios.System.Switchinterface("switchinterfaceResource", new()
    {
        DynamicSortSubtable = "string",
        GetAllTables = "string",
        IntraSwitchPolicy = "string",
        MacTtl = 0,
        Members = new[]
        {
            new Fortios.System.Inputs.SwitchinterfaceMemberArgs
            {
                InterfaceName = "string",
            },
        },
        Name = "string",
        Span = "string",
        SpanDestPort = "string",
        SpanDirection = "string",
        SpanSourcePorts = new[]
        {
            new Fortios.System.Inputs.SwitchinterfaceSpanSourcePortArgs
            {
                InterfaceName = "string",
            },
        },
        Type = "string",
        Vdom = "string",
        Vdomparam = "string",
    });
    
    example, err := system.NewSwitchinterface(ctx, "switchinterfaceResource", &system.SwitchinterfaceArgs{
    	DynamicSortSubtable: pulumi.String("string"),
    	GetAllTables:        pulumi.String("string"),
    	IntraSwitchPolicy:   pulumi.String("string"),
    	MacTtl:              pulumi.Int(0),
    	Members: system.SwitchinterfaceMemberArray{
    		&system.SwitchinterfaceMemberArgs{
    			InterfaceName: pulumi.String("string"),
    		},
    	},
    	Name:          pulumi.String("string"),
    	Span:          pulumi.String("string"),
    	SpanDestPort:  pulumi.String("string"),
    	SpanDirection: pulumi.String("string"),
    	SpanSourcePorts: system.SwitchinterfaceSpanSourcePortArray{
    		&system.SwitchinterfaceSpanSourcePortArgs{
    			InterfaceName: pulumi.String("string"),
    		},
    	},
    	Type:      pulumi.String("string"),
    	Vdom:      pulumi.String("string"),
    	Vdomparam: pulumi.String("string"),
    })
    
    var switchinterfaceResource = new Switchinterface("switchinterfaceResource", SwitchinterfaceArgs.builder()
        .dynamicSortSubtable("string")
        .getAllTables("string")
        .intraSwitchPolicy("string")
        .macTtl(0)
        .members(SwitchinterfaceMemberArgs.builder()
            .interfaceName("string")
            .build())
        .name("string")
        .span("string")
        .spanDestPort("string")
        .spanDirection("string")
        .spanSourcePorts(SwitchinterfaceSpanSourcePortArgs.builder()
            .interfaceName("string")
            .build())
        .type("string")
        .vdom("string")
        .vdomparam("string")
        .build());
    
    switchinterface_resource = fortios.system.Switchinterface("switchinterfaceResource",
        dynamic_sort_subtable="string",
        get_all_tables="string",
        intra_switch_policy="string",
        mac_ttl=0,
        members=[{
            "interface_name": "string",
        }],
        name="string",
        span="string",
        span_dest_port="string",
        span_direction="string",
        span_source_ports=[{
            "interface_name": "string",
        }],
        type="string",
        vdom="string",
        vdomparam="string")
    
    const switchinterfaceResource = new fortios.system.Switchinterface("switchinterfaceResource", {
        dynamicSortSubtable: "string",
        getAllTables: "string",
        intraSwitchPolicy: "string",
        macTtl: 0,
        members: [{
            interfaceName: "string",
        }],
        name: "string",
        span: "string",
        spanDestPort: "string",
        spanDirection: "string",
        spanSourcePorts: [{
            interfaceName: "string",
        }],
        type: "string",
        vdom: "string",
        vdomparam: "string",
    });
    
    type: fortios:system:Switchinterface
    properties:
        dynamicSortSubtable: string
        getAllTables: string
        intraSwitchPolicy: string
        macTtl: 0
        members:
            - interfaceName: string
        name: string
        span: string
        spanDestPort: string
        spanDirection: string
        spanSourcePorts:
            - interfaceName: string
        type: string
        vdom: string
        vdomparam: string
    

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

    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    IntraSwitchPolicy string
    Allow any traffic between switch interfaces or require firewall policies to allow traffic between switch interfaces. Valid values: implicit, explicit.
    MacTtl int
    Duration for which MAC addresses are held in the ARP table (300 - 8640000 sec, default = 300).
    Members List<Pulumiverse.Fortios.System.Inputs.SwitchinterfaceMember>
    Names of the interfaces that belong to the virtual switch. The structure of member block is documented below.
    Name string
    Interface name (name cannot be in use by any other interfaces, VLANs, or inter-VDOM links).
    Span string
    Enable/disable port spanning. Port spanning echoes traffic received by the software switch to the span destination port. Valid values: disable, enable.
    SpanDestPort string
    SPAN destination port name. All traffic on the SPAN source ports is echoed to the SPAN destination port.
    SpanDirection string
    The direction in which the SPAN port operates, either: rx, tx, or both. Valid values: rx, tx, both.
    SpanSourcePorts List<Pulumiverse.Fortios.System.Inputs.SwitchinterfaceSpanSourcePort>
    Physical interface name. Port spanning echoes all traffic on the SPAN source ports to the SPAN destination port. The structure of span_source_port block is documented below.
    Type string
    Type of switch based on functionality: switch for normal functionality, or hub to duplicate packets to all port members. Valid values: switch, hub.
    Vdom string
    VDOM that the software switch belongs to.
    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.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    IntraSwitchPolicy string
    Allow any traffic between switch interfaces or require firewall policies to allow traffic between switch interfaces. Valid values: implicit, explicit.
    MacTtl int
    Duration for which MAC addresses are held in the ARP table (300 - 8640000 sec, default = 300).
    Members []SwitchinterfaceMemberArgs
    Names of the interfaces that belong to the virtual switch. The structure of member block is documented below.
    Name string
    Interface name (name cannot be in use by any other interfaces, VLANs, or inter-VDOM links).
    Span string
    Enable/disable port spanning. Port spanning echoes traffic received by the software switch to the span destination port. Valid values: disable, enable.
    SpanDestPort string
    SPAN destination port name. All traffic on the SPAN source ports is echoed to the SPAN destination port.
    SpanDirection string
    The direction in which the SPAN port operates, either: rx, tx, or both. Valid values: rx, tx, both.
    SpanSourcePorts []SwitchinterfaceSpanSourcePortArgs
    Physical interface name. Port spanning echoes all traffic on the SPAN source ports to the SPAN destination port. The structure of span_source_port block is documented below.
    Type string
    Type of switch based on functionality: switch for normal functionality, or hub to duplicate packets to all port members. Valid values: switch, hub.
    Vdom string
    VDOM that the software switch belongs to.
    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.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    intraSwitchPolicy String
    Allow any traffic between switch interfaces or require firewall policies to allow traffic between switch interfaces. Valid values: implicit, explicit.
    macTtl Integer
    Duration for which MAC addresses are held in the ARP table (300 - 8640000 sec, default = 300).
    members List<SwitchinterfaceMember>
    Names of the interfaces that belong to the virtual switch. The structure of member block is documented below.
    name String
    Interface name (name cannot be in use by any other interfaces, VLANs, or inter-VDOM links).
    span String
    Enable/disable port spanning. Port spanning echoes traffic received by the software switch to the span destination port. Valid values: disable, enable.
    spanDestPort String
    SPAN destination port name. All traffic on the SPAN source ports is echoed to the SPAN destination port.
    spanDirection String
    The direction in which the SPAN port operates, either: rx, tx, or both. Valid values: rx, tx, both.
    spanSourcePorts List<SwitchinterfaceSpanSourcePort>
    Physical interface name. Port spanning echoes all traffic on the SPAN source ports to the SPAN destination port. The structure of span_source_port block is documented below.
    type String
    Type of switch based on functionality: switch for normal functionality, or hub to duplicate packets to all port members. Valid values: switch, hub.
    vdom String
    VDOM that the software switch belongs to.
    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.
    dynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    intraSwitchPolicy string
    Allow any traffic between switch interfaces or require firewall policies to allow traffic between switch interfaces. Valid values: implicit, explicit.
    macTtl number
    Duration for which MAC addresses are held in the ARP table (300 - 8640000 sec, default = 300).
    members SwitchinterfaceMember[]
    Names of the interfaces that belong to the virtual switch. The structure of member block is documented below.
    name string
    Interface name (name cannot be in use by any other interfaces, VLANs, or inter-VDOM links).
    span string
    Enable/disable port spanning. Port spanning echoes traffic received by the software switch to the span destination port. Valid values: disable, enable.
    spanDestPort string
    SPAN destination port name. All traffic on the SPAN source ports is echoed to the SPAN destination port.
    spanDirection string
    The direction in which the SPAN port operates, either: rx, tx, or both. Valid values: rx, tx, both.
    spanSourcePorts SwitchinterfaceSpanSourcePort[]
    Physical interface name. Port spanning echoes all traffic on the SPAN source ports to the SPAN destination port. The structure of span_source_port block is documented below.
    type string
    Type of switch based on functionality: switch for normal functionality, or hub to duplicate packets to all port members. Valid values: switch, hub.
    vdom string
    VDOM that the software switch belongs to.
    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.
    dynamic_sort_subtable str
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    get_all_tables str
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    intra_switch_policy str
    Allow any traffic between switch interfaces or require firewall policies to allow traffic between switch interfaces. Valid values: implicit, explicit.
    mac_ttl int
    Duration for which MAC addresses are held in the ARP table (300 - 8640000 sec, default = 300).
    members Sequence[SwitchinterfaceMemberArgs]
    Names of the interfaces that belong to the virtual switch. The structure of member block is documented below.
    name str
    Interface name (name cannot be in use by any other interfaces, VLANs, or inter-VDOM links).
    span str
    Enable/disable port spanning. Port spanning echoes traffic received by the software switch to the span destination port. Valid values: disable, enable.
    span_dest_port str
    SPAN destination port name. All traffic on the SPAN source ports is echoed to the SPAN destination port.
    span_direction str
    The direction in which the SPAN port operates, either: rx, tx, or both. Valid values: rx, tx, both.
    span_source_ports Sequence[SwitchinterfaceSpanSourcePortArgs]
    Physical interface name. Port spanning echoes all traffic on the SPAN source ports to the SPAN destination port. The structure of span_source_port block is documented below.
    type str
    Type of switch based on functionality: switch for normal functionality, or hub to duplicate packets to all port members. Valid values: switch, hub.
    vdom str
    VDOM that the software switch belongs to.
    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.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    intraSwitchPolicy String
    Allow any traffic between switch interfaces or require firewall policies to allow traffic between switch interfaces. Valid values: implicit, explicit.
    macTtl Number
    Duration for which MAC addresses are held in the ARP table (300 - 8640000 sec, default = 300).
    members List<Property Map>
    Names of the interfaces that belong to the virtual switch. The structure of member block is documented below.
    name String
    Interface name (name cannot be in use by any other interfaces, VLANs, or inter-VDOM links).
    span String
    Enable/disable port spanning. Port spanning echoes traffic received by the software switch to the span destination port. Valid values: disable, enable.
    spanDestPort String
    SPAN destination port name. All traffic on the SPAN source ports is echoed to the SPAN destination port.
    spanDirection String
    The direction in which the SPAN port operates, either: rx, tx, or both. Valid values: rx, tx, both.
    spanSourcePorts List<Property Map>
    Physical interface name. Port spanning echoes all traffic on the SPAN source ports to the SPAN destination port. The structure of span_source_port block is documented below.
    type String
    Type of switch based on functionality: switch for normal functionality, or hub to duplicate packets to all port members. Valid values: switch, hub.
    vdom String
    VDOM that the software switch belongs to.
    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 Switchinterface 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 Switchinterface Resource

    Get an existing Switchinterface 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?: SwitchinterfaceState, opts?: CustomResourceOptions): Switchinterface
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            dynamic_sort_subtable: Optional[str] = None,
            get_all_tables: Optional[str] = None,
            intra_switch_policy: Optional[str] = None,
            mac_ttl: Optional[int] = None,
            members: Optional[Sequence[SwitchinterfaceMemberArgs]] = None,
            name: Optional[str] = None,
            span: Optional[str] = None,
            span_dest_port: Optional[str] = None,
            span_direction: Optional[str] = None,
            span_source_ports: Optional[Sequence[SwitchinterfaceSpanSourcePortArgs]] = None,
            type: Optional[str] = None,
            vdom: Optional[str] = None,
            vdomparam: Optional[str] = None) -> Switchinterface
    func GetSwitchinterface(ctx *Context, name string, id IDInput, state *SwitchinterfaceState, opts ...ResourceOption) (*Switchinterface, error)
    public static Switchinterface Get(string name, Input<string> id, SwitchinterfaceState? state, CustomResourceOptions? opts = null)
    public static Switchinterface get(String name, Output<String> id, SwitchinterfaceState 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:
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    IntraSwitchPolicy string
    Allow any traffic between switch interfaces or require firewall policies to allow traffic between switch interfaces. Valid values: implicit, explicit.
    MacTtl int
    Duration for which MAC addresses are held in the ARP table (300 - 8640000 sec, default = 300).
    Members List<Pulumiverse.Fortios.System.Inputs.SwitchinterfaceMember>
    Names of the interfaces that belong to the virtual switch. The structure of member block is documented below.
    Name string
    Interface name (name cannot be in use by any other interfaces, VLANs, or inter-VDOM links).
    Span string
    Enable/disable port spanning. Port spanning echoes traffic received by the software switch to the span destination port. Valid values: disable, enable.
    SpanDestPort string
    SPAN destination port name. All traffic on the SPAN source ports is echoed to the SPAN destination port.
    SpanDirection string
    The direction in which the SPAN port operates, either: rx, tx, or both. Valid values: rx, tx, both.
    SpanSourcePorts List<Pulumiverse.Fortios.System.Inputs.SwitchinterfaceSpanSourcePort>
    Physical interface name. Port spanning echoes all traffic on the SPAN source ports to the SPAN destination port. The structure of span_source_port block is documented below.
    Type string
    Type of switch based on functionality: switch for normal functionality, or hub to duplicate packets to all port members. Valid values: switch, hub.
    Vdom string
    VDOM that the software switch belongs to.
    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.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    IntraSwitchPolicy string
    Allow any traffic between switch interfaces or require firewall policies to allow traffic between switch interfaces. Valid values: implicit, explicit.
    MacTtl int
    Duration for which MAC addresses are held in the ARP table (300 - 8640000 sec, default = 300).
    Members []SwitchinterfaceMemberArgs
    Names of the interfaces that belong to the virtual switch. The structure of member block is documented below.
    Name string
    Interface name (name cannot be in use by any other interfaces, VLANs, or inter-VDOM links).
    Span string
    Enable/disable port spanning. Port spanning echoes traffic received by the software switch to the span destination port. Valid values: disable, enable.
    SpanDestPort string
    SPAN destination port name. All traffic on the SPAN source ports is echoed to the SPAN destination port.
    SpanDirection string
    The direction in which the SPAN port operates, either: rx, tx, or both. Valid values: rx, tx, both.
    SpanSourcePorts []SwitchinterfaceSpanSourcePortArgs
    Physical interface name. Port spanning echoes all traffic on the SPAN source ports to the SPAN destination port. The structure of span_source_port block is documented below.
    Type string
    Type of switch based on functionality: switch for normal functionality, or hub to duplicate packets to all port members. Valid values: switch, hub.
    Vdom string
    VDOM that the software switch belongs to.
    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.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    intraSwitchPolicy String
    Allow any traffic between switch interfaces or require firewall policies to allow traffic between switch interfaces. Valid values: implicit, explicit.
    macTtl Integer
    Duration for which MAC addresses are held in the ARP table (300 - 8640000 sec, default = 300).
    members List<SwitchinterfaceMember>
    Names of the interfaces that belong to the virtual switch. The structure of member block is documented below.
    name String
    Interface name (name cannot be in use by any other interfaces, VLANs, or inter-VDOM links).
    span String
    Enable/disable port spanning. Port spanning echoes traffic received by the software switch to the span destination port. Valid values: disable, enable.
    spanDestPort String
    SPAN destination port name. All traffic on the SPAN source ports is echoed to the SPAN destination port.
    spanDirection String
    The direction in which the SPAN port operates, either: rx, tx, or both. Valid values: rx, tx, both.
    spanSourcePorts List<SwitchinterfaceSpanSourcePort>
    Physical interface name. Port spanning echoes all traffic on the SPAN source ports to the SPAN destination port. The structure of span_source_port block is documented below.
    type String
    Type of switch based on functionality: switch for normal functionality, or hub to duplicate packets to all port members. Valid values: switch, hub.
    vdom String
    VDOM that the software switch belongs to.
    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.
    dynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    intraSwitchPolicy string
    Allow any traffic between switch interfaces or require firewall policies to allow traffic between switch interfaces. Valid values: implicit, explicit.
    macTtl number
    Duration for which MAC addresses are held in the ARP table (300 - 8640000 sec, default = 300).
    members SwitchinterfaceMember[]
    Names of the interfaces that belong to the virtual switch. The structure of member block is documented below.
    name string
    Interface name (name cannot be in use by any other interfaces, VLANs, or inter-VDOM links).
    span string
    Enable/disable port spanning. Port spanning echoes traffic received by the software switch to the span destination port. Valid values: disable, enable.
    spanDestPort string
    SPAN destination port name. All traffic on the SPAN source ports is echoed to the SPAN destination port.
    spanDirection string
    The direction in which the SPAN port operates, either: rx, tx, or both. Valid values: rx, tx, both.
    spanSourcePorts SwitchinterfaceSpanSourcePort[]
    Physical interface name. Port spanning echoes all traffic on the SPAN source ports to the SPAN destination port. The structure of span_source_port block is documented below.
    type string
    Type of switch based on functionality: switch for normal functionality, or hub to duplicate packets to all port members. Valid values: switch, hub.
    vdom string
    VDOM that the software switch belongs to.
    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.
    dynamic_sort_subtable str
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    get_all_tables str
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    intra_switch_policy str
    Allow any traffic between switch interfaces or require firewall policies to allow traffic between switch interfaces. Valid values: implicit, explicit.
    mac_ttl int
    Duration for which MAC addresses are held in the ARP table (300 - 8640000 sec, default = 300).
    members Sequence[SwitchinterfaceMemberArgs]
    Names of the interfaces that belong to the virtual switch. The structure of member block is documented below.
    name str
    Interface name (name cannot be in use by any other interfaces, VLANs, or inter-VDOM links).
    span str
    Enable/disable port spanning. Port spanning echoes traffic received by the software switch to the span destination port. Valid values: disable, enable.
    span_dest_port str
    SPAN destination port name. All traffic on the SPAN source ports is echoed to the SPAN destination port.
    span_direction str
    The direction in which the SPAN port operates, either: rx, tx, or both. Valid values: rx, tx, both.
    span_source_ports Sequence[SwitchinterfaceSpanSourcePortArgs]
    Physical interface name. Port spanning echoes all traffic on the SPAN source ports to the SPAN destination port. The structure of span_source_port block is documented below.
    type str
    Type of switch based on functionality: switch for normal functionality, or hub to duplicate packets to all port members. Valid values: switch, hub.
    vdom str
    VDOM that the software switch belongs to.
    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.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    intraSwitchPolicy String
    Allow any traffic between switch interfaces or require firewall policies to allow traffic between switch interfaces. Valid values: implicit, explicit.
    macTtl Number
    Duration for which MAC addresses are held in the ARP table (300 - 8640000 sec, default = 300).
    members List<Property Map>
    Names of the interfaces that belong to the virtual switch. The structure of member block is documented below.
    name String
    Interface name (name cannot be in use by any other interfaces, VLANs, or inter-VDOM links).
    span String
    Enable/disable port spanning. Port spanning echoes traffic received by the software switch to the span destination port. Valid values: disable, enable.
    spanDestPort String
    SPAN destination port name. All traffic on the SPAN source ports is echoed to the SPAN destination port.
    spanDirection String
    The direction in which the SPAN port operates, either: rx, tx, or both. Valid values: rx, tx, both.
    spanSourcePorts List<Property Map>
    Physical interface name. Port spanning echoes all traffic on the SPAN source ports to the SPAN destination port. The structure of span_source_port block is documented below.
    type String
    Type of switch based on functionality: switch for normal functionality, or hub to duplicate packets to all port members. Valid values: switch, hub.
    vdom String
    VDOM that the software switch belongs to.
    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.

    Supporting Types

    SwitchinterfaceMember, SwitchinterfaceMemberArgs

    InterfaceName string
    Physical interface name.
    InterfaceName string
    Physical interface name.
    interfaceName String
    Physical interface name.
    interfaceName string
    Physical interface name.
    interface_name str
    Physical interface name.
    interfaceName String
    Physical interface name.

    SwitchinterfaceSpanSourcePort, SwitchinterfaceSpanSourcePortArgs

    InterfaceName string
    Physical interface name.
    InterfaceName string
    Physical interface name.
    interfaceName String
    Physical interface name.
    interfaceName string
    Physical interface name.
    interface_name str
    Physical interface name.
    interfaceName String
    Physical interface name.

    Import

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

    $ pulumi import fortios:system/switchinterface:Switchinterface labelname {{name}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:system/switchinterface:Switchinterface labelname {{name}}
    

    $ 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