1. Packages
  2. Fortios
  3. API Docs
  4. system
  5. Geneve
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

fortios.system.Geneve

Explore with Pulumi AI

fortios logo
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

    Configure GENEVE devices. Applies to FortiOS Version >= 6.2.4.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as fortios from "@pulumiverse/fortios";
    
    const trname = new fortios.system.Geneve("trname", {
        dstport: 22,
        "interface": "port2",
        ipVersion: "ipv4-unicast",
        remoteIp: "1.1.1.1",
        remoteIp6: "::",
        vni: 0,
    });
    
    import pulumi
    import pulumiverse_fortios as fortios
    
    trname = fortios.system.Geneve("trname",
        dstport=22,
        interface="port2",
        ip_version="ipv4-unicast",
        remote_ip="1.1.1.1",
        remote_ip6="::",
        vni=0)
    
    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.NewGeneve(ctx, "trname", &system.GeneveArgs{
    			Dstport:   pulumi.Int(22),
    			Interface: pulumi.String("port2"),
    			IpVersion: pulumi.String("ipv4-unicast"),
    			RemoteIp:  pulumi.String("1.1.1.1"),
    			RemoteIp6: pulumi.String("::"),
    			Vni:       pulumi.Int(0),
    		})
    		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.Geneve("trname", new()
        {
            Dstport = 22,
            Interface = "port2",
            IpVersion = "ipv4-unicast",
            RemoteIp = "1.1.1.1",
            RemoteIp6 = "::",
            Vni = 0,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.fortios.system.Geneve;
    import com.pulumi.fortios.system.GeneveArgs;
    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 Geneve("trname", GeneveArgs.builder()        
                .dstport(22)
                .interface_("port2")
                .ipVersion("ipv4-unicast")
                .remoteIp("1.1.1.1")
                .remoteIp6("::")
                .vni(0)
                .build());
    
        }
    }
    
    resources:
      trname:
        type: fortios:system:Geneve
        properties:
          dstport: 22
          interface: port2
          ipVersion: ipv4-unicast
          remoteIp: 1.1.1.1
          remoteIp6: '::'
          vni: 0
    

    Create Geneve Resource

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

    Constructor syntax

    new Geneve(name: string, args: GeneveArgs, opts?: CustomResourceOptions);
    @overload
    def Geneve(resource_name: str,
               args: GeneveArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Geneve(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               interface: Optional[str] = None,
               ip_version: Optional[str] = None,
               remote_ip: Optional[str] = None,
               vni: Optional[int] = None,
               dstport: Optional[int] = None,
               name: Optional[str] = None,
               remote_ip6: Optional[str] = None,
               type: Optional[str] = None,
               vdomparam: Optional[str] = None)
    func NewGeneve(ctx *Context, name string, args GeneveArgs, opts ...ResourceOption) (*Geneve, error)
    public Geneve(string name, GeneveArgs args, CustomResourceOptions? opts = null)
    public Geneve(String name, GeneveArgs args)
    public Geneve(String name, GeneveArgs args, CustomResourceOptions options)
    
    type: fortios:system:Geneve
    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 GeneveArgs
    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 GeneveArgs
    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 GeneveArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GeneveArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GeneveArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var geneveResource = new Fortios.System.Geneve("geneveResource", new()
    {
        Interface = "string",
        IpVersion = "string",
        RemoteIp = "string",
        Vni = 0,
        Dstport = 0,
        Name = "string",
        RemoteIp6 = "string",
        Type = "string",
        Vdomparam = "string",
    });
    
    example, err := system.NewGeneve(ctx, "geneveResource", &system.GeneveArgs{
    	Interface: pulumi.String("string"),
    	IpVersion: pulumi.String("string"),
    	RemoteIp:  pulumi.String("string"),
    	Vni:       pulumi.Int(0),
    	Dstport:   pulumi.Int(0),
    	Name:      pulumi.String("string"),
    	RemoteIp6: pulumi.String("string"),
    	Type:      pulumi.String("string"),
    	Vdomparam: pulumi.String("string"),
    })
    
    var geneveResource = new Geneve("geneveResource", GeneveArgs.builder()        
        .interface_("string")
        .ipVersion("string")
        .remoteIp("string")
        .vni(0)
        .dstport(0)
        .name("string")
        .remoteIp6("string")
        .type("string")
        .vdomparam("string")
        .build());
    
    geneve_resource = fortios.system.Geneve("geneveResource",
        interface="string",
        ip_version="string",
        remote_ip="string",
        vni=0,
        dstport=0,
        name="string",
        remote_ip6="string",
        type="string",
        vdomparam="string")
    
    const geneveResource = new fortios.system.Geneve("geneveResource", {
        "interface": "string",
        ipVersion: "string",
        remoteIp: "string",
        vni: 0,
        dstport: 0,
        name: "string",
        remoteIp6: "string",
        type: "string",
        vdomparam: "string",
    });
    
    type: fortios:system:Geneve
    properties:
        dstport: 0
        interface: string
        ipVersion: string
        name: string
        remoteIp: string
        remoteIp6: string
        type: string
        vdomparam: string
        vni: 0
    

    Geneve Resource Properties

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

    Inputs

    The Geneve resource accepts the following input properties:

    Interface string
    Outgoing interface for GENEVE encapsulated traffic.
    IpVersion string
    IP version to use for the GENEVE interface and so for communication over the GENEVE. IPv4 or IPv6 unicast. Valid values: ipv4-unicast, ipv6-unicast.
    RemoteIp string
    IPv4 address of the GENEVE interface on the device at the remote end of the GENEVE.
    Vni int
    GENEVE network ID.
    Dstport int
    GENEVE destination port (1 - 65535, default = 6081).
    Name string
    GENEVE device or interface name. Must be an unique interface name.
    RemoteIp6 string
    IPv6 IP address of the GENEVE interface on the device at the remote end of the GENEVE.
    Type string
    GENEVE type. Valid values: ethernet, ppp.
    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 GENEVE encapsulated traffic.
    IpVersion string
    IP version to use for the GENEVE interface and so for communication over the GENEVE. IPv4 or IPv6 unicast. Valid values: ipv4-unicast, ipv6-unicast.
    RemoteIp string
    IPv4 address of the GENEVE interface on the device at the remote end of the GENEVE.
    Vni int
    GENEVE network ID.
    Dstport int
    GENEVE destination port (1 - 65535, default = 6081).
    Name string
    GENEVE device or interface name. Must be an unique interface name.
    RemoteIp6 string
    IPv6 IP address of the GENEVE interface on the device at the remote end of the GENEVE.
    Type string
    GENEVE type. Valid values: ethernet, ppp.
    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 GENEVE encapsulated traffic.
    ipVersion String
    IP version to use for the GENEVE interface and so for communication over the GENEVE. IPv4 or IPv6 unicast. Valid values: ipv4-unicast, ipv6-unicast.
    remoteIp String
    IPv4 address of the GENEVE interface on the device at the remote end of the GENEVE.
    vni Integer
    GENEVE network ID.
    dstport Integer
    GENEVE destination port (1 - 65535, default = 6081).
    name String
    GENEVE device or interface name. Must be an unique interface name.
    remoteIp6 String
    IPv6 IP address of the GENEVE interface on the device at the remote end of the GENEVE.
    type String
    GENEVE type. Valid values: ethernet, ppp.
    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 GENEVE encapsulated traffic.
    ipVersion string
    IP version to use for the GENEVE interface and so for communication over the GENEVE. IPv4 or IPv6 unicast. Valid values: ipv4-unicast, ipv6-unicast.
    remoteIp string
    IPv4 address of the GENEVE interface on the device at the remote end of the GENEVE.
    vni number
    GENEVE network ID.
    dstport number
    GENEVE destination port (1 - 65535, default = 6081).
    name string
    GENEVE device or interface name. Must be an unique interface name.
    remoteIp6 string
    IPv6 IP address of the GENEVE interface on the device at the remote end of the GENEVE.
    type string
    GENEVE type. Valid values: ethernet, ppp.
    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 GENEVE encapsulated traffic.
    ip_version str
    IP version to use for the GENEVE interface and so for communication over the GENEVE. IPv4 or IPv6 unicast. Valid values: ipv4-unicast, ipv6-unicast.
    remote_ip str
    IPv4 address of the GENEVE interface on the device at the remote end of the GENEVE.
    vni int
    GENEVE network ID.
    dstport int
    GENEVE destination port (1 - 65535, default = 6081).
    name str
    GENEVE device or interface name. Must be an unique interface name.
    remote_ip6 str
    IPv6 IP address of the GENEVE interface on the device at the remote end of the GENEVE.
    type str
    GENEVE type. Valid values: ethernet, ppp.
    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 GENEVE encapsulated traffic.
    ipVersion String
    IP version to use for the GENEVE interface and so for communication over the GENEVE. IPv4 or IPv6 unicast. Valid values: ipv4-unicast, ipv6-unicast.
    remoteIp String
    IPv4 address of the GENEVE interface on the device at the remote end of the GENEVE.
    vni Number
    GENEVE network ID.
    dstport Number
    GENEVE destination port (1 - 65535, default = 6081).
    name String
    GENEVE device or interface name. Must be an unique interface name.
    remoteIp6 String
    IPv6 IP address of the GENEVE interface on the device at the remote end of the GENEVE.
    type String
    GENEVE type. Valid values: ethernet, ppp.
    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 Geneve 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 Geneve Resource

    Get an existing Geneve 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?: GeneveState, opts?: CustomResourceOptions): Geneve
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            dstport: Optional[int] = None,
            interface: Optional[str] = None,
            ip_version: Optional[str] = None,
            name: Optional[str] = None,
            remote_ip: Optional[str] = None,
            remote_ip6: Optional[str] = None,
            type: Optional[str] = None,
            vdomparam: Optional[str] = None,
            vni: Optional[int] = None) -> Geneve
    func GetGeneve(ctx *Context, name string, id IDInput, state *GeneveState, opts ...ResourceOption) (*Geneve, error)
    public static Geneve Get(string name, Input<string> id, GeneveState? state, CustomResourceOptions? opts = null)
    public static Geneve get(String name, Output<String> id, GeneveState 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
    GENEVE destination port (1 - 65535, default = 6081).
    Interface string
    Outgoing interface for GENEVE encapsulated traffic.
    IpVersion string
    IP version to use for the GENEVE interface and so for communication over the GENEVE. IPv4 or IPv6 unicast. Valid values: ipv4-unicast, ipv6-unicast.
    Name string
    GENEVE device or interface name. Must be an unique interface name.
    RemoteIp string
    IPv4 address of the GENEVE interface on the device at the remote end of the GENEVE.
    RemoteIp6 string
    IPv6 IP address of the GENEVE interface on the device at the remote end of the GENEVE.
    Type string
    GENEVE type. Valid values: ethernet, ppp.
    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
    GENEVE network ID.
    Dstport int
    GENEVE destination port (1 - 65535, default = 6081).
    Interface string
    Outgoing interface for GENEVE encapsulated traffic.
    IpVersion string
    IP version to use for the GENEVE interface and so for communication over the GENEVE. IPv4 or IPv6 unicast. Valid values: ipv4-unicast, ipv6-unicast.
    Name string
    GENEVE device or interface name. Must be an unique interface name.
    RemoteIp string
    IPv4 address of the GENEVE interface on the device at the remote end of the GENEVE.
    RemoteIp6 string
    IPv6 IP address of the GENEVE interface on the device at the remote end of the GENEVE.
    Type string
    GENEVE type. Valid values: ethernet, ppp.
    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
    GENEVE network ID.
    dstport Integer
    GENEVE destination port (1 - 65535, default = 6081).
    interface_ String
    Outgoing interface for GENEVE encapsulated traffic.
    ipVersion String
    IP version to use for the GENEVE interface and so for communication over the GENEVE. IPv4 or IPv6 unicast. Valid values: ipv4-unicast, ipv6-unicast.
    name String
    GENEVE device or interface name. Must be an unique interface name.
    remoteIp String
    IPv4 address of the GENEVE interface on the device at the remote end of the GENEVE.
    remoteIp6 String
    IPv6 IP address of the GENEVE interface on the device at the remote end of the GENEVE.
    type String
    GENEVE type. Valid values: ethernet, ppp.
    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
    GENEVE network ID.
    dstport number
    GENEVE destination port (1 - 65535, default = 6081).
    interface string
    Outgoing interface for GENEVE encapsulated traffic.
    ipVersion string
    IP version to use for the GENEVE interface and so for communication over the GENEVE. IPv4 or IPv6 unicast. Valid values: ipv4-unicast, ipv6-unicast.
    name string
    GENEVE device or interface name. Must be an unique interface name.
    remoteIp string
    IPv4 address of the GENEVE interface on the device at the remote end of the GENEVE.
    remoteIp6 string
    IPv6 IP address of the GENEVE interface on the device at the remote end of the GENEVE.
    type string
    GENEVE type. Valid values: ethernet, ppp.
    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
    GENEVE network ID.
    dstport int
    GENEVE destination port (1 - 65535, default = 6081).
    interface str
    Outgoing interface for GENEVE encapsulated traffic.
    ip_version str
    IP version to use for the GENEVE interface and so for communication over the GENEVE. IPv4 or IPv6 unicast. Valid values: ipv4-unicast, ipv6-unicast.
    name str
    GENEVE device or interface name. Must be an unique interface name.
    remote_ip str
    IPv4 address of the GENEVE interface on the device at the remote end of the GENEVE.
    remote_ip6 str
    IPv6 IP address of the GENEVE interface on the device at the remote end of the GENEVE.
    type str
    GENEVE type. Valid values: ethernet, ppp.
    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
    GENEVE network ID.
    dstport Number
    GENEVE destination port (1 - 65535, default = 6081).
    interface String
    Outgoing interface for GENEVE encapsulated traffic.
    ipVersion String
    IP version to use for the GENEVE interface and so for communication over the GENEVE. IPv4 or IPv6 unicast. Valid values: ipv4-unicast, ipv6-unicast.
    name String
    GENEVE device or interface name. Must be an unique interface name.
    remoteIp String
    IPv4 address of the GENEVE interface on the device at the remote end of the GENEVE.
    remoteIp6 String
    IPv6 IP address of the GENEVE interface on the device at the remote end of the GENEVE.
    type String
    GENEVE type. Valid values: ethernet, ppp.
    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
    GENEVE network ID.

    Import

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

    $ pulumi import fortios:system/geneve:Geneve labelname {{name}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:system/geneve:Geneve 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.5 published on Tuesday, Apr 9, 2024 by pulumiverse