fortios.system.Virtualswitch
Explore with Pulumi AI
Configure virtual hardware switch interfaces. Applies to FortiOS Version 7.0.4
.
Create Virtualswitch Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Virtualswitch(name: string, args?: VirtualswitchArgs, opts?: CustomResourceOptions);
@overload
def Virtualswitch(resource_name: str,
args: Optional[VirtualswitchArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Virtualswitch(resource_name: str,
opts: Optional[ResourceOptions] = None,
dynamic_sort_subtable: Optional[str] = None,
get_all_tables: Optional[str] = None,
name: Optional[str] = None,
physical_switch: Optional[str] = None,
ports: Optional[Sequence[VirtualswitchPortArgs]] = None,
span: Optional[str] = None,
span_dest_port: Optional[str] = None,
span_direction: Optional[str] = None,
span_source_port: Optional[str] = None,
vdomparam: Optional[str] = None,
vlan: Optional[int] = None)
func NewVirtualswitch(ctx *Context, name string, args *VirtualswitchArgs, opts ...ResourceOption) (*Virtualswitch, error)
public Virtualswitch(string name, VirtualswitchArgs? args = null, CustomResourceOptions? opts = null)
public Virtualswitch(String name, VirtualswitchArgs args)
public Virtualswitch(String name, VirtualswitchArgs args, CustomResourceOptions options)
type: fortios:system:Virtualswitch
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 VirtualswitchArgs
- 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 VirtualswitchArgs
- 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 VirtualswitchArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args VirtualswitchArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args VirtualswitchArgs
- 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 virtualswitchResource = new Fortios.System.Virtualswitch("virtualswitchResource", new()
{
DynamicSortSubtable = "string",
GetAllTables = "string",
Name = "string",
PhysicalSwitch = "string",
Ports = new[]
{
new Fortios.System.Inputs.VirtualswitchPortArgs
{
Alias = "string",
Name = "string",
},
},
Span = "string",
SpanDestPort = "string",
SpanDirection = "string",
SpanSourcePort = "string",
Vdomparam = "string",
Vlan = 0,
});
example, err := system.NewVirtualswitch(ctx, "virtualswitchResource", &system.VirtualswitchArgs{
DynamicSortSubtable: pulumi.String("string"),
GetAllTables: pulumi.String("string"),
Name: pulumi.String("string"),
PhysicalSwitch: pulumi.String("string"),
Ports: system.VirtualswitchPortArray{
&system.VirtualswitchPortArgs{
Alias: pulumi.String("string"),
Name: pulumi.String("string"),
},
},
Span: pulumi.String("string"),
SpanDestPort: pulumi.String("string"),
SpanDirection: pulumi.String("string"),
SpanSourcePort: pulumi.String("string"),
Vdomparam: pulumi.String("string"),
Vlan: pulumi.Int(0),
})
var virtualswitchResource = new Virtualswitch("virtualswitchResource", VirtualswitchArgs.builder()
.dynamicSortSubtable("string")
.getAllTables("string")
.name("string")
.physicalSwitch("string")
.ports(VirtualswitchPortArgs.builder()
.alias("string")
.name("string")
.build())
.span("string")
.spanDestPort("string")
.spanDirection("string")
.spanSourcePort("string")
.vdomparam("string")
.vlan(0)
.build());
virtualswitch_resource = fortios.system.Virtualswitch("virtualswitchResource",
dynamic_sort_subtable="string",
get_all_tables="string",
name="string",
physical_switch="string",
ports=[{
"alias": "string",
"name": "string",
}],
span="string",
span_dest_port="string",
span_direction="string",
span_source_port="string",
vdomparam="string",
vlan=0)
const virtualswitchResource = new fortios.system.Virtualswitch("virtualswitchResource", {
dynamicSortSubtable: "string",
getAllTables: "string",
name: "string",
physicalSwitch: "string",
ports: [{
alias: "string",
name: "string",
}],
span: "string",
spanDestPort: "string",
spanDirection: "string",
spanSourcePort: "string",
vdomparam: "string",
vlan: 0,
});
type: fortios:system:Virtualswitch
properties:
dynamicSortSubtable: string
getAllTables: string
name: string
physicalSwitch: string
ports:
- alias: string
name: string
span: string
spanDestPort: string
spanDirection: string
spanSourcePort: string
vdomparam: string
vlan: 0
Virtualswitch 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 Virtualswitch resource accepts the following input properties:
- Dynamic
Sort stringSubtable - 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 stringTables - 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.
- Name string
- Name of the virtual switch.
- Physical
Switch string - Physical switch parent.
- Ports
List<Pulumiverse.
Fortios. System. Inputs. Virtualswitch Port> - Configure member ports. The structure of
port
block is documented below. - Span string
- Enable/disable SPAN. Valid values:
disable
,enable
. - Span
Dest stringPort - SPAN destination port.
- Span
Direction string - SPAN direction. Valid values:
rx
,tx
,both
. - Span
Source stringPort - SPAN source port.
- 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.
- Vlan int
- VLAN.
- Dynamic
Sort stringSubtable - 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 stringTables - 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.
- Name string
- Name of the virtual switch.
- Physical
Switch string - Physical switch parent.
- Ports
[]Virtualswitch
Port Args - Configure member ports. The structure of
port
block is documented below. - Span string
- Enable/disable SPAN. Valid values:
disable
,enable
. - Span
Dest stringPort - SPAN destination port.
- Span
Direction string - SPAN direction. Valid values:
rx
,tx
,both
. - Span
Source stringPort - SPAN source port.
- 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.
- Vlan int
- VLAN.
- dynamic
Sort StringSubtable - 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 StringTables - 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.
- name String
- Name of the virtual switch.
- physical
Switch String - Physical switch parent.
- ports
List<Virtualswitch
Port> - Configure member ports. The structure of
port
block is documented below. - span String
- Enable/disable SPAN. Valid values:
disable
,enable
. - span
Dest StringPort - SPAN destination port.
- span
Direction String - SPAN direction. Valid values:
rx
,tx
,both
. - span
Source StringPort - SPAN source port.
- 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.
- vlan Integer
- VLAN.
- dynamic
Sort stringSubtable - 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 stringTables - 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.
- name string
- Name of the virtual switch.
- physical
Switch string - Physical switch parent.
- ports
Virtualswitch
Port[] - Configure member ports. The structure of
port
block is documented below. - span string
- Enable/disable SPAN. Valid values:
disable
,enable
. - span
Dest stringPort - SPAN destination port.
- span
Direction string - SPAN direction. Valid values:
rx
,tx
,both
. - span
Source stringPort - SPAN source port.
- 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.
- vlan number
- VLAN.
- dynamic_
sort_ strsubtable - 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_ strtables - 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.
- name str
- Name of the virtual switch.
- physical_
switch str - Physical switch parent.
- ports
Sequence[Virtualswitch
Port Args] - Configure member ports. The structure of
port
block is documented below. - span str
- Enable/disable SPAN. Valid values:
disable
,enable
. - span_
dest_ strport - SPAN destination port.
- span_
direction str - SPAN direction. Valid values:
rx
,tx
,both
. - span_
source_ strport - SPAN source port.
- 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.
- vlan int
- VLAN.
- dynamic
Sort StringSubtable - 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 StringTables - 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.
- name String
- Name of the virtual switch.
- physical
Switch String - Physical switch parent.
- ports List<Property Map>
- Configure member ports. The structure of
port
block is documented below. - span String
- Enable/disable SPAN. Valid values:
disable
,enable
. - span
Dest StringPort - SPAN destination port.
- span
Direction String - SPAN direction. Valid values:
rx
,tx
,both
. - span
Source StringPort - SPAN source port.
- 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.
- vlan Number
- VLAN.
Outputs
All input properties are implicitly available as output properties. Additionally, the Virtualswitch 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 Virtualswitch Resource
Get an existing Virtualswitch 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?: VirtualswitchState, opts?: CustomResourceOptions): Virtualswitch
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
dynamic_sort_subtable: Optional[str] = None,
get_all_tables: Optional[str] = None,
name: Optional[str] = None,
physical_switch: Optional[str] = None,
ports: Optional[Sequence[VirtualswitchPortArgs]] = None,
span: Optional[str] = None,
span_dest_port: Optional[str] = None,
span_direction: Optional[str] = None,
span_source_port: Optional[str] = None,
vdomparam: Optional[str] = None,
vlan: Optional[int] = None) -> Virtualswitch
func GetVirtualswitch(ctx *Context, name string, id IDInput, state *VirtualswitchState, opts ...ResourceOption) (*Virtualswitch, error)
public static Virtualswitch Get(string name, Input<string> id, VirtualswitchState? state, CustomResourceOptions? opts = null)
public static Virtualswitch get(String name, Output<String> id, VirtualswitchState 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.
- Dynamic
Sort stringSubtable - 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 stringTables - 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.
- Name string
- Name of the virtual switch.
- Physical
Switch string - Physical switch parent.
- Ports
List<Pulumiverse.
Fortios. System. Inputs. Virtualswitch Port> - Configure member ports. The structure of
port
block is documented below. - Span string
- Enable/disable SPAN. Valid values:
disable
,enable
. - Span
Dest stringPort - SPAN destination port.
- Span
Direction string - SPAN direction. Valid values:
rx
,tx
,both
. - Span
Source stringPort - SPAN source port.
- 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.
- Vlan int
- VLAN.
- Dynamic
Sort stringSubtable - 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 stringTables - 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.
- Name string
- Name of the virtual switch.
- Physical
Switch string - Physical switch parent.
- Ports
[]Virtualswitch
Port Args - Configure member ports. The structure of
port
block is documented below. - Span string
- Enable/disable SPAN. Valid values:
disable
,enable
. - Span
Dest stringPort - SPAN destination port.
- Span
Direction string - SPAN direction. Valid values:
rx
,tx
,both
. - Span
Source stringPort - SPAN source port.
- 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.
- Vlan int
- VLAN.
- dynamic
Sort StringSubtable - 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 StringTables - 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.
- name String
- Name of the virtual switch.
- physical
Switch String - Physical switch parent.
- ports
List<Virtualswitch
Port> - Configure member ports. The structure of
port
block is documented below. - span String
- Enable/disable SPAN. Valid values:
disable
,enable
. - span
Dest StringPort - SPAN destination port.
- span
Direction String - SPAN direction. Valid values:
rx
,tx
,both
. - span
Source StringPort - SPAN source port.
- 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.
- vlan Integer
- VLAN.
- dynamic
Sort stringSubtable - 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 stringTables - 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.
- name string
- Name of the virtual switch.
- physical
Switch string - Physical switch parent.
- ports
Virtualswitch
Port[] - Configure member ports. The structure of
port
block is documented below. - span string
- Enable/disable SPAN. Valid values:
disable
,enable
. - span
Dest stringPort - SPAN destination port.
- span
Direction string - SPAN direction. Valid values:
rx
,tx
,both
. - span
Source stringPort - SPAN source port.
- 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.
- vlan number
- VLAN.
- dynamic_
sort_ strsubtable - 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_ strtables - 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.
- name str
- Name of the virtual switch.
- physical_
switch str - Physical switch parent.
- ports
Sequence[Virtualswitch
Port Args] - Configure member ports. The structure of
port
block is documented below. - span str
- Enable/disable SPAN. Valid values:
disable
,enable
. - span_
dest_ strport - SPAN destination port.
- span_
direction str - SPAN direction. Valid values:
rx
,tx
,both
. - span_
source_ strport - SPAN source port.
- 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.
- vlan int
- VLAN.
- dynamic
Sort StringSubtable - 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 StringTables - 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.
- name String
- Name of the virtual switch.
- physical
Switch String - Physical switch parent.
- ports List<Property Map>
- Configure member ports. The structure of
port
block is documented below. - span String
- Enable/disable SPAN. Valid values:
disable
,enable
. - span
Dest StringPort - SPAN destination port.
- span
Direction String - SPAN direction. Valid values:
rx
,tx
,both
. - span
Source StringPort - SPAN source port.
- 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.
- vlan Number
- VLAN.
Supporting Types
VirtualswitchPort, VirtualswitchPortArgs
Import
System VirtualSwitch can be imported using any of these accepted formats:
$ pulumi import fortios:system/virtualswitch:Virtualswitch labelname {{name}}
If you do not want to import arguments of block:
$ export “FORTIOS_IMPORT_TABLE”=“false”
$ pulumi import fortios:system/virtualswitch:Virtualswitch 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.