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

fortios.system.Vxlan

Explore with Pulumi AI

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

    Configure VXLAN devices.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as fortios from "@pulumiverse/fortios";
    
    const trname = new fortios.system.Vxlan("trname", {
        dstport: 4789,
        "interface": "port3",
        ipVersion: "ipv4-unicast",
        remoteIps: [{
            ip: "1.1.1.1",
        }],
        vni: 3,
    });
    
    import pulumi
    import pulumiverse_fortios as fortios
    
    trname = fortios.system.Vxlan("trname",
        dstport=4789,
        interface="port3",
        ip_version="ipv4-unicast",
        remote_ips=[fortios.system.VxlanRemoteIpArgs(
            ip="1.1.1.1",
        )],
        vni=3)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-fortios/sdk/go/fortios/system"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := system.NewVxlan(ctx, "trname", &system.VxlanArgs{
    			Dstport:   pulumi.Int(4789),
    			Interface: pulumi.String("port3"),
    			IpVersion: pulumi.String("ipv4-unicast"),
    			RemoteIps: system.VxlanRemoteIpArray{
    				&system.VxlanRemoteIpArgs{
    					Ip: pulumi.String("1.1.1.1"),
    				},
    			},
    			Vni: pulumi.Int(3),
    		})
    		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.System.Vxlan("trname", new()
        {
            Dstport = 4789,
            Interface = "port3",
            IpVersion = "ipv4-unicast",
            RemoteIps = new[]
            {
                new Fortios.System.Inputs.VxlanRemoteIpArgs
                {
                    Ip = "1.1.1.1",
                },
            },
            Vni = 3,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.fortios.system.Vxlan;
    import com.pulumi.fortios.system.VxlanArgs;
    import com.pulumi.fortios.system.inputs.VxlanRemoteIpArgs;
    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 Vxlan("trname", VxlanArgs.builder()
                .dstport(4789)
                .interface_("port3")
                .ipVersion("ipv4-unicast")
                .remoteIps(VxlanRemoteIpArgs.builder()
                    .ip("1.1.1.1")
                    .build())
                .vni(3)
                .build());
    
        }
    }
    
    resources:
      trname:
        type: fortios:system:Vxlan
        properties:
          dstport: 4789
          interface: port3
          ipVersion: ipv4-unicast
          remoteIps:
            - ip: 1.1.1.1
          vni: 3
    

    Create Vxlan Resource

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

    Constructor syntax

    new Vxlan(name: string, args: VxlanArgs, opts?: CustomResourceOptions);
    @overload
    def Vxlan(resource_name: str,
              args: VxlanArgs,
              opts: Optional[ResourceOptions] = None)
    
    @overload
    def Vxlan(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              interface: Optional[str] = None,
              vni: Optional[int] = None,
              ip_version: Optional[str] = None,
              learn_from_traffic: Optional[str] = None,
              get_all_tables: Optional[str] = None,
              evpn_id: Optional[int] = None,
              dstport: Optional[int] = None,
              multicast_ttl: Optional[int] = None,
              name: Optional[str] = None,
              remote_ip6s: Optional[Sequence[VxlanRemoteIp6Args]] = None,
              remote_ips: Optional[Sequence[VxlanRemoteIpArgs]] = None,
              vdomparam: Optional[str] = None,
              dynamic_sort_subtable: Optional[str] = None)
    func NewVxlan(ctx *Context, name string, args VxlanArgs, opts ...ResourceOption) (*Vxlan, error)
    public Vxlan(string name, VxlanArgs args, CustomResourceOptions? opts = null)
    public Vxlan(String name, VxlanArgs args)
    public Vxlan(String name, VxlanArgs args, CustomResourceOptions options)
    
    type: fortios:system:Vxlan
    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 VxlanArgs
    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 VxlanArgs
    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 VxlanArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VxlanArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VxlanArgs
    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 vxlanResource = new Fortios.System.Vxlan("vxlanResource", new()
    {
        Interface = "string",
        Vni = 0,
        IpVersion = "string",
        LearnFromTraffic = "string",
        GetAllTables = "string",
        EvpnId = 0,
        Dstport = 0,
        MulticastTtl = 0,
        Name = "string",
        RemoteIp6s = new[]
        {
            new Fortios.System.Inputs.VxlanRemoteIp6Args
            {
                Ip6 = "string",
            },
        },
        RemoteIps = new[]
        {
            new Fortios.System.Inputs.VxlanRemoteIpArgs
            {
                Ip = "string",
            },
        },
        Vdomparam = "string",
        DynamicSortSubtable = "string",
    });
    
    example, err := system.NewVxlan(ctx, "vxlanResource", &system.VxlanArgs{
    	Interface:        pulumi.String("string"),
    	Vni:              pulumi.Int(0),
    	IpVersion:        pulumi.String("string"),
    	LearnFromTraffic: pulumi.String("string"),
    	GetAllTables:     pulumi.String("string"),
    	EvpnId:           pulumi.Int(0),
    	Dstport:          pulumi.Int(0),
    	MulticastTtl:     pulumi.Int(0),
    	Name:             pulumi.String("string"),
    	RemoteIp6s: system.VxlanRemoteIp6Array{
    		&system.VxlanRemoteIp6Args{
    			Ip6: pulumi.String("string"),
    		},
    	},
    	RemoteIps: system.VxlanRemoteIpArray{
    		&system.VxlanRemoteIpArgs{
    			Ip: pulumi.String("string"),
    		},
    	},
    	Vdomparam:           pulumi.String("string"),
    	DynamicSortSubtable: pulumi.String("string"),
    })
    
    var vxlanResource = new Vxlan("vxlanResource", VxlanArgs.builder()
        .interface_("string")
        .vni(0)
        .ipVersion("string")
        .learnFromTraffic("string")
        .getAllTables("string")
        .evpnId(0)
        .dstport(0)
        .multicastTtl(0)
        .name("string")
        .remoteIp6s(VxlanRemoteIp6Args.builder()
            .ip6("string")
            .build())
        .remoteIps(VxlanRemoteIpArgs.builder()
            .ip("string")
            .build())
        .vdomparam("string")
        .dynamicSortSubtable("string")
        .build());
    
    vxlan_resource = fortios.system.Vxlan("vxlanResource",
        interface="string",
        vni=0,
        ip_version="string",
        learn_from_traffic="string",
        get_all_tables="string",
        evpn_id=0,
        dstport=0,
        multicast_ttl=0,
        name="string",
        remote_ip6s=[{
            "ip6": "string",
        }],
        remote_ips=[{
            "ip": "string",
        }],
        vdomparam="string",
        dynamic_sort_subtable="string")
    
    const vxlanResource = new fortios.system.Vxlan("vxlanResource", {
        "interface": "string",
        vni: 0,
        ipVersion: "string",
        learnFromTraffic: "string",
        getAllTables: "string",
        evpnId: 0,
        dstport: 0,
        multicastTtl: 0,
        name: "string",
        remoteIp6s: [{
            ip6: "string",
        }],
        remoteIps: [{
            ip: "string",
        }],
        vdomparam: "string",
        dynamicSortSubtable: "string",
    });
    
    type: fortios:system:Vxlan
    properties:
        dstport: 0
        dynamicSortSubtable: string
        evpnId: 0
        getAllTables: string
        interface: string
        ipVersion: string
        learnFromTraffic: string
        multicastTtl: 0
        name: string
        remoteIp6s:
            - ip6: string
        remoteIps:
            - ip: string
        vdomparam: string
        vni: 0
    

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

    Interface string
    Outgoing interface for VXLAN encapsulated traffic.
    IpVersion string
    IP version to use for the VXLAN interface and so for communication over the VXLAN. IPv4 or IPv6 unicast or multicast. Valid values: ipv4-unicast, ipv6-unicast, ipv4-multicast, ipv6-multicast.
    Vni int
    VXLAN network ID.
    Dstport int
    VXLAN destination port (1 - 65535, default = 4789).
    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 ].
    EvpnId int
    EVPN instance.
    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.
    LearnFromTraffic string
    Enable/disable VXLAN MAC learning from traffic. Valid values: enable, disable.
    MulticastTtl int
    VXLAN multicast TTL (1-255, default = 0).
    Name string
    VXLAN device or interface name. Must be a unique interface name.
    RemoteIp6s List<Pulumiverse.Fortios.System.Inputs.VxlanRemoteIp6>
    IPv6 IP address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip6 block is documented below.
    RemoteIps List<Pulumiverse.Fortios.System.Inputs.VxlanRemoteIp>
    IPv4 address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip block is documented below.
    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.
    Interface string
    Outgoing interface for VXLAN encapsulated traffic.
    IpVersion string
    IP version to use for the VXLAN interface and so for communication over the VXLAN. IPv4 or IPv6 unicast or multicast. Valid values: ipv4-unicast, ipv6-unicast, ipv4-multicast, ipv6-multicast.
    Vni int
    VXLAN network ID.
    Dstport int
    VXLAN destination port (1 - 65535, default = 4789).
    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 ].
    EvpnId int
    EVPN instance.
    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.
    LearnFromTraffic string
    Enable/disable VXLAN MAC learning from traffic. Valid values: enable, disable.
    MulticastTtl int
    VXLAN multicast TTL (1-255, default = 0).
    Name string
    VXLAN device or interface name. Must be a unique interface name.
    RemoteIp6s []VxlanRemoteIp6Args
    IPv6 IP address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip6 block is documented below.
    RemoteIps []VxlanRemoteIpArgs
    IPv4 address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip block is documented below.
    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.
    interface_ String
    Outgoing interface for VXLAN encapsulated traffic.
    ipVersion String
    IP version to use for the VXLAN interface and so for communication over the VXLAN. IPv4 or IPv6 unicast or multicast. Valid values: ipv4-unicast, ipv6-unicast, ipv4-multicast, ipv6-multicast.
    vni Integer
    VXLAN network ID.
    dstport Integer
    VXLAN destination port (1 - 65535, default = 4789).
    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 ].
    evpnId Integer
    EVPN instance.
    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.
    learnFromTraffic String
    Enable/disable VXLAN MAC learning from traffic. Valid values: enable, disable.
    multicastTtl Integer
    VXLAN multicast TTL (1-255, default = 0).
    name String
    VXLAN device or interface name. Must be a unique interface name.
    remoteIp6s List<VxlanRemoteIp6>
    IPv6 IP address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip6 block is documented below.
    remoteIps List<VxlanRemoteIp>
    IPv4 address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip block is documented below.
    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.
    interface string
    Outgoing interface for VXLAN encapsulated traffic.
    ipVersion string
    IP version to use for the VXLAN interface and so for communication over the VXLAN. IPv4 or IPv6 unicast or multicast. Valid values: ipv4-unicast, ipv6-unicast, ipv4-multicast, ipv6-multicast.
    vni number
    VXLAN network ID.
    dstport number
    VXLAN destination port (1 - 65535, default = 4789).
    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 ].
    evpnId number
    EVPN instance.
    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.
    learnFromTraffic string
    Enable/disable VXLAN MAC learning from traffic. Valid values: enable, disable.
    multicastTtl number
    VXLAN multicast TTL (1-255, default = 0).
    name string
    VXLAN device or interface name. Must be a unique interface name.
    remoteIp6s VxlanRemoteIp6[]
    IPv6 IP address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip6 block is documented below.
    remoteIps VxlanRemoteIp[]
    IPv4 address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip block is documented below.
    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.
    interface str
    Outgoing interface for VXLAN encapsulated traffic.
    ip_version str
    IP version to use for the VXLAN interface and so for communication over the VXLAN. IPv4 or IPv6 unicast or multicast. Valid values: ipv4-unicast, ipv6-unicast, ipv4-multicast, ipv6-multicast.
    vni int
    VXLAN network ID.
    dstport int
    VXLAN destination port (1 - 65535, default = 4789).
    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 ].
    evpn_id int
    EVPN instance.
    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.
    learn_from_traffic str
    Enable/disable VXLAN MAC learning from traffic. Valid values: enable, disable.
    multicast_ttl int
    VXLAN multicast TTL (1-255, default = 0).
    name str
    VXLAN device or interface name. Must be a unique interface name.
    remote_ip6s Sequence[VxlanRemoteIp6Args]
    IPv6 IP address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip6 block is documented below.
    remote_ips Sequence[VxlanRemoteIpArgs]
    IPv4 address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip block is documented below.
    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.
    interface String
    Outgoing interface for VXLAN encapsulated traffic.
    ipVersion String
    IP version to use for the VXLAN interface and so for communication over the VXLAN. IPv4 or IPv6 unicast or multicast. Valid values: ipv4-unicast, ipv6-unicast, ipv4-multicast, ipv6-multicast.
    vni Number
    VXLAN network ID.
    dstport Number
    VXLAN destination port (1 - 65535, default = 4789).
    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 ].
    evpnId Number
    EVPN instance.
    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.
    learnFromTraffic String
    Enable/disable VXLAN MAC learning from traffic. Valid values: enable, disable.
    multicastTtl Number
    VXLAN multicast TTL (1-255, default = 0).
    name String
    VXLAN device or interface name. Must be a unique interface name.
    remoteIp6s List<Property Map>
    IPv6 IP address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip6 block is documented below.
    remoteIps List<Property Map>
    IPv4 address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip block is documented below.
    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 Vxlan 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 Vxlan Resource

    Get an existing Vxlan 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?: VxlanState, opts?: CustomResourceOptions): Vxlan
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            dstport: Optional[int] = None,
            dynamic_sort_subtable: Optional[str] = None,
            evpn_id: Optional[int] = None,
            get_all_tables: Optional[str] = None,
            interface: Optional[str] = None,
            ip_version: Optional[str] = None,
            learn_from_traffic: Optional[str] = None,
            multicast_ttl: Optional[int] = None,
            name: Optional[str] = None,
            remote_ip6s: Optional[Sequence[VxlanRemoteIp6Args]] = None,
            remote_ips: Optional[Sequence[VxlanRemoteIpArgs]] = None,
            vdomparam: Optional[str] = None,
            vni: Optional[int] = None) -> Vxlan
    func GetVxlan(ctx *Context, name string, id IDInput, state *VxlanState, opts ...ResourceOption) (*Vxlan, error)
    public static Vxlan Get(string name, Input<string> id, VxlanState? state, CustomResourceOptions? opts = null)
    public static Vxlan get(String name, Output<String> id, VxlanState 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:
    Dstport int
    VXLAN destination port (1 - 65535, default = 4789).
    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 ].
    EvpnId int
    EVPN instance.
    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.
    Interface string
    Outgoing interface for VXLAN encapsulated traffic.
    IpVersion string
    IP version to use for the VXLAN interface and so for communication over the VXLAN. IPv4 or IPv6 unicast or multicast. Valid values: ipv4-unicast, ipv6-unicast, ipv4-multicast, ipv6-multicast.
    LearnFromTraffic string
    Enable/disable VXLAN MAC learning from traffic. Valid values: enable, disable.
    MulticastTtl int
    VXLAN multicast TTL (1-255, default = 0).
    Name string
    VXLAN device or interface name. Must be a unique interface name.
    RemoteIp6s List<Pulumiverse.Fortios.System.Inputs.VxlanRemoteIp6>
    IPv6 IP address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip6 block is documented below.
    RemoteIps List<Pulumiverse.Fortios.System.Inputs.VxlanRemoteIp>
    IPv4 address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip block is documented below.
    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.
    Vni int
    VXLAN network ID.
    Dstport int
    VXLAN destination port (1 - 65535, default = 4789).
    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 ].
    EvpnId int
    EVPN instance.
    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.
    Interface string
    Outgoing interface for VXLAN encapsulated traffic.
    IpVersion string
    IP version to use for the VXLAN interface and so for communication over the VXLAN. IPv4 or IPv6 unicast or multicast. Valid values: ipv4-unicast, ipv6-unicast, ipv4-multicast, ipv6-multicast.
    LearnFromTraffic string
    Enable/disable VXLAN MAC learning from traffic. Valid values: enable, disable.
    MulticastTtl int
    VXLAN multicast TTL (1-255, default = 0).
    Name string
    VXLAN device or interface name. Must be a unique interface name.
    RemoteIp6s []VxlanRemoteIp6Args
    IPv6 IP address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip6 block is documented below.
    RemoteIps []VxlanRemoteIpArgs
    IPv4 address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip block is documented below.
    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.
    Vni int
    VXLAN network ID.
    dstport Integer
    VXLAN destination port (1 - 65535, default = 4789).
    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 ].
    evpnId Integer
    EVPN instance.
    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.
    interface_ String
    Outgoing interface for VXLAN encapsulated traffic.
    ipVersion String
    IP version to use for the VXLAN interface and so for communication over the VXLAN. IPv4 or IPv6 unicast or multicast. Valid values: ipv4-unicast, ipv6-unicast, ipv4-multicast, ipv6-multicast.
    learnFromTraffic String
    Enable/disable VXLAN MAC learning from traffic. Valid values: enable, disable.
    multicastTtl Integer
    VXLAN multicast TTL (1-255, default = 0).
    name String
    VXLAN device or interface name. Must be a unique interface name.
    remoteIp6s List<VxlanRemoteIp6>
    IPv6 IP address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip6 block is documented below.
    remoteIps List<VxlanRemoteIp>
    IPv4 address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip block is documented below.
    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.
    vni Integer
    VXLAN network ID.
    dstport number
    VXLAN destination port (1 - 65535, default = 4789).
    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 ].
    evpnId number
    EVPN instance.
    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.
    interface string
    Outgoing interface for VXLAN encapsulated traffic.
    ipVersion string
    IP version to use for the VXLAN interface and so for communication over the VXLAN. IPv4 or IPv6 unicast or multicast. Valid values: ipv4-unicast, ipv6-unicast, ipv4-multicast, ipv6-multicast.
    learnFromTraffic string
    Enable/disable VXLAN MAC learning from traffic. Valid values: enable, disable.
    multicastTtl number
    VXLAN multicast TTL (1-255, default = 0).
    name string
    VXLAN device or interface name. Must be a unique interface name.
    remoteIp6s VxlanRemoteIp6[]
    IPv6 IP address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip6 block is documented below.
    remoteIps VxlanRemoteIp[]
    IPv4 address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip block is documented below.
    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.
    vni number
    VXLAN network ID.
    dstport int
    VXLAN destination port (1 - 65535, default = 4789).
    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 ].
    evpn_id int
    EVPN instance.
    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.
    interface str
    Outgoing interface for VXLAN encapsulated traffic.
    ip_version str
    IP version to use for the VXLAN interface and so for communication over the VXLAN. IPv4 or IPv6 unicast or multicast. Valid values: ipv4-unicast, ipv6-unicast, ipv4-multicast, ipv6-multicast.
    learn_from_traffic str
    Enable/disable VXLAN MAC learning from traffic. Valid values: enable, disable.
    multicast_ttl int
    VXLAN multicast TTL (1-255, default = 0).
    name str
    VXLAN device or interface name. Must be a unique interface name.
    remote_ip6s Sequence[VxlanRemoteIp6Args]
    IPv6 IP address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip6 block is documented below.
    remote_ips Sequence[VxlanRemoteIpArgs]
    IPv4 address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip block is documented below.
    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.
    vni int
    VXLAN network ID.
    dstport Number
    VXLAN destination port (1 - 65535, default = 4789).
    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 ].
    evpnId Number
    EVPN instance.
    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.
    interface String
    Outgoing interface for VXLAN encapsulated traffic.
    ipVersion String
    IP version to use for the VXLAN interface and so for communication over the VXLAN. IPv4 or IPv6 unicast or multicast. Valid values: ipv4-unicast, ipv6-unicast, ipv4-multicast, ipv6-multicast.
    learnFromTraffic String
    Enable/disable VXLAN MAC learning from traffic. Valid values: enable, disable.
    multicastTtl Number
    VXLAN multicast TTL (1-255, default = 0).
    name String
    VXLAN device or interface name. Must be a unique interface name.
    remoteIp6s List<Property Map>
    IPv6 IP address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip6 block is documented below.
    remoteIps List<Property Map>
    IPv4 address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip block is documented below.
    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.
    vni Number
    VXLAN network ID.

    Supporting Types

    VxlanRemoteIp, VxlanRemoteIpArgs

    Ip string

    IPv4 address.

    The remote_ip6 block supports:

    Ip string

    IPv4 address.

    The remote_ip6 block supports:

    ip String

    IPv4 address.

    The remote_ip6 block supports:

    ip string

    IPv4 address.

    The remote_ip6 block supports:

    ip str

    IPv4 address.

    The remote_ip6 block supports:

    ip String

    IPv4 address.

    The remote_ip6 block supports:

    VxlanRemoteIp6, VxlanRemoteIp6Args

    Ip6 string
    Ip6 string
    ip6 String
    ip6 string
    ip6 str
    ip6 String

    Import

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

    $ pulumi import fortios:system/vxlan:Vxlan labelname {{name}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:system/vxlan:Vxlan 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