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

fortios.firewall.ObjectVip

Explore with Pulumi AI

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

    Provides a resource to configure firewall virtual IPs (VIPs) of FortiOS.

    !> Warning: The resource will be deprecated and replaced by new resource fortios.firewall.Vip, we recommend that you use the new resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as fortios from "@pulumiverse/fortios";
    
    const v11 = new fortios.firewall.ObjectVip("v11", {
        comment: "fdsafdsafds",
        extintf: "port3",
        extip: "11.1.1.1-21.1.1.1",
        extport: "2-3",
        mappedips: ["22.2.2.2-32.2.2.2"],
        mappedport: "4-5",
        portforward: "enable",
        protocol: "tcp",
    });
    
    import pulumi
    import pulumiverse_fortios as fortios
    
    v11 = fortios.firewall.ObjectVip("v11",
        comment="fdsafdsafds",
        extintf="port3",
        extip="11.1.1.1-21.1.1.1",
        extport="2-3",
        mappedips=["22.2.2.2-32.2.2.2"],
        mappedport="4-5",
        portforward="enable",
        protocol="tcp")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-fortios/sdk/go/fortios/firewall"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := firewall.NewObjectVip(ctx, "v11", &firewall.ObjectVipArgs{
    			Comment: pulumi.String("fdsafdsafds"),
    			Extintf: pulumi.String("port3"),
    			Extip:   pulumi.String("11.1.1.1-21.1.1.1"),
    			Extport: pulumi.String("2-3"),
    			Mappedips: pulumi.StringArray{
    				pulumi.String("22.2.2.2-32.2.2.2"),
    			},
    			Mappedport:  pulumi.String("4-5"),
    			Portforward: pulumi.String("enable"),
    			Protocol:    pulumi.String("tcp"),
    		})
    		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 v11 = new Fortios.Firewall.ObjectVip("v11", new()
        {
            Comment = "fdsafdsafds",
            Extintf = "port3",
            Extip = "11.1.1.1-21.1.1.1",
            Extport = "2-3",
            Mappedips = new[]
            {
                "22.2.2.2-32.2.2.2",
            },
            Mappedport = "4-5",
            Portforward = "enable",
            Protocol = "tcp",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.fortios.firewall.ObjectVip;
    import com.pulumi.fortios.firewall.ObjectVipArgs;
    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 v11 = new ObjectVip("v11", ObjectVipArgs.builder()        
                .comment("fdsafdsafds")
                .extintf("port3")
                .extip("11.1.1.1-21.1.1.1")
                .extport("2-3")
                .mappedips("22.2.2.2-32.2.2.2")
                .mappedport("4-5")
                .portforward("enable")
                .protocol("tcp")
                .build());
    
        }
    }
    
    resources:
      v11:
        type: fortios:firewall:ObjectVip
        properties:
          comment: fdsafdsafds
          extintf: port3
          extip: 11.1.1.1-21.1.1.1
          extport: 2-3
          mappedips:
            - 22.2.2.2-32.2.2.2
          mappedport: 4-5
          portforward: enable
          protocol: tcp
    

    Create ObjectVip Resource

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

    Constructor syntax

    new ObjectVip(name: string, args: ObjectVipArgs, opts?: CustomResourceOptions);
    @overload
    def ObjectVip(resource_name: str,
                  args: ObjectVipArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def ObjectVip(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  extip: Optional[str] = None,
                  mappedips: Optional[Sequence[str]] = None,
                  comment: Optional[str] = None,
                  extintf: Optional[str] = None,
                  extport: Optional[str] = None,
                  mappedport: Optional[str] = None,
                  name: Optional[str] = None,
                  portforward: Optional[str] = None,
                  protocol: Optional[str] = None)
    func NewObjectVip(ctx *Context, name string, args ObjectVipArgs, opts ...ResourceOption) (*ObjectVip, error)
    public ObjectVip(string name, ObjectVipArgs args, CustomResourceOptions? opts = null)
    public ObjectVip(String name, ObjectVipArgs args)
    public ObjectVip(String name, ObjectVipArgs args, CustomResourceOptions options)
    
    type: fortios:firewall:ObjectVip
    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 ObjectVipArgs
    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 ObjectVipArgs
    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 ObjectVipArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ObjectVipArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ObjectVipArgs
    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 objectVipResource = new Fortios.Firewall.ObjectVip("objectVipResource", new()
    {
        Extip = "string",
        Mappedips = new[]
        {
            "string",
        },
        Comment = "string",
        Extintf = "string",
        Extport = "string",
        Mappedport = "string",
        Name = "string",
        Portforward = "string",
        Protocol = "string",
    });
    
    example, err := firewall.NewObjectVip(ctx, "objectVipResource", &firewall.ObjectVipArgs{
    	Extip: pulumi.String("string"),
    	Mappedips: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Comment:     pulumi.String("string"),
    	Extintf:     pulumi.String("string"),
    	Extport:     pulumi.String("string"),
    	Mappedport:  pulumi.String("string"),
    	Name:        pulumi.String("string"),
    	Portforward: pulumi.String("string"),
    	Protocol:    pulumi.String("string"),
    })
    
    var objectVipResource = new ObjectVip("objectVipResource", ObjectVipArgs.builder()
        .extip("string")
        .mappedips("string")
        .comment("string")
        .extintf("string")
        .extport("string")
        .mappedport("string")
        .name("string")
        .portforward("string")
        .protocol("string")
        .build());
    
    object_vip_resource = fortios.firewall.ObjectVip("objectVipResource",
        extip="string",
        mappedips=["string"],
        comment="string",
        extintf="string",
        extport="string",
        mappedport="string",
        name="string",
        portforward="string",
        protocol="string")
    
    const objectVipResource = new fortios.firewall.ObjectVip("objectVipResource", {
        extip: "string",
        mappedips: ["string"],
        comment: "string",
        extintf: "string",
        extport: "string",
        mappedport: "string",
        name: "string",
        portforward: "string",
        protocol: "string",
    });
    
    type: fortios:firewall:ObjectVip
    properties:
        comment: string
        extintf: string
        extip: string
        extport: string
        mappedips:
            - string
        mappedport: string
        name: string
        portforward: string
        protocol: string
    

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

    Extip string
    IP address or address range on the external interface that you want to map to an address or address range on the destination network.
    Mappedips List<string>
    IP address or address range on the destination network to which the external IP address is mapped.
    Comment string
    Comment.
    Extintf string
    Interface connected to the source network that receives the packets that will be forwarded to the destination network.
    Extport string
    Incoming port number range that you want to map to a port number range on the destination network.
    Mappedport string
    Port number range on the destination network to which the external port number range is mapped.
    Name string
    Virtual IP name.
    Portforward string
    Enable/disable port forwarding.
    Protocol string
    Protocol to use when forwarding packets.
    Extip string
    IP address or address range on the external interface that you want to map to an address or address range on the destination network.
    Mappedips []string
    IP address or address range on the destination network to which the external IP address is mapped.
    Comment string
    Comment.
    Extintf string
    Interface connected to the source network that receives the packets that will be forwarded to the destination network.
    Extport string
    Incoming port number range that you want to map to a port number range on the destination network.
    Mappedport string
    Port number range on the destination network to which the external port number range is mapped.
    Name string
    Virtual IP name.
    Portforward string
    Enable/disable port forwarding.
    Protocol string
    Protocol to use when forwarding packets.
    extip String
    IP address or address range on the external interface that you want to map to an address or address range on the destination network.
    mappedips List<String>
    IP address or address range on the destination network to which the external IP address is mapped.
    comment String
    Comment.
    extintf String
    Interface connected to the source network that receives the packets that will be forwarded to the destination network.
    extport String
    Incoming port number range that you want to map to a port number range on the destination network.
    mappedport String
    Port number range on the destination network to which the external port number range is mapped.
    name String
    Virtual IP name.
    portforward String
    Enable/disable port forwarding.
    protocol String
    Protocol to use when forwarding packets.
    extip string
    IP address or address range on the external interface that you want to map to an address or address range on the destination network.
    mappedips string[]
    IP address or address range on the destination network to which the external IP address is mapped.
    comment string
    Comment.
    extintf string
    Interface connected to the source network that receives the packets that will be forwarded to the destination network.
    extport string
    Incoming port number range that you want to map to a port number range on the destination network.
    mappedport string
    Port number range on the destination network to which the external port number range is mapped.
    name string
    Virtual IP name.
    portforward string
    Enable/disable port forwarding.
    protocol string
    Protocol to use when forwarding packets.
    extip str
    IP address or address range on the external interface that you want to map to an address or address range on the destination network.
    mappedips Sequence[str]
    IP address or address range on the destination network to which the external IP address is mapped.
    comment str
    Comment.
    extintf str
    Interface connected to the source network that receives the packets that will be forwarded to the destination network.
    extport str
    Incoming port number range that you want to map to a port number range on the destination network.
    mappedport str
    Port number range on the destination network to which the external port number range is mapped.
    name str
    Virtual IP name.
    portforward str
    Enable/disable port forwarding.
    protocol str
    Protocol to use when forwarding packets.
    extip String
    IP address or address range on the external interface that you want to map to an address or address range on the destination network.
    mappedips List<String>
    IP address or address range on the destination network to which the external IP address is mapped.
    comment String
    Comment.
    extintf String
    Interface connected to the source network that receives the packets that will be forwarded to the destination network.
    extport String
    Incoming port number range that you want to map to a port number range on the destination network.
    mappedport String
    Port number range on the destination network to which the external port number range is mapped.
    name String
    Virtual IP name.
    portforward String
    Enable/disable port forwarding.
    protocol String
    Protocol to use when forwarding packets.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ObjectVip 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 ObjectVip Resource

    Get an existing ObjectVip 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?: ObjectVipState, opts?: CustomResourceOptions): ObjectVip
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            comment: Optional[str] = None,
            extintf: Optional[str] = None,
            extip: Optional[str] = None,
            extport: Optional[str] = None,
            mappedips: Optional[Sequence[str]] = None,
            mappedport: Optional[str] = None,
            name: Optional[str] = None,
            portforward: Optional[str] = None,
            protocol: Optional[str] = None) -> ObjectVip
    func GetObjectVip(ctx *Context, name string, id IDInput, state *ObjectVipState, opts ...ResourceOption) (*ObjectVip, error)
    public static ObjectVip Get(string name, Input<string> id, ObjectVipState? state, CustomResourceOptions? opts = null)
    public static ObjectVip get(String name, Output<String> id, ObjectVipState 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:
    Comment string
    Comment.
    Extintf string
    Interface connected to the source network that receives the packets that will be forwarded to the destination network.
    Extip string
    IP address or address range on the external interface that you want to map to an address or address range on the destination network.
    Extport string
    Incoming port number range that you want to map to a port number range on the destination network.
    Mappedips List<string>
    IP address or address range on the destination network to which the external IP address is mapped.
    Mappedport string
    Port number range on the destination network to which the external port number range is mapped.
    Name string
    Virtual IP name.
    Portforward string
    Enable/disable port forwarding.
    Protocol string
    Protocol to use when forwarding packets.
    Comment string
    Comment.
    Extintf string
    Interface connected to the source network that receives the packets that will be forwarded to the destination network.
    Extip string
    IP address or address range on the external interface that you want to map to an address or address range on the destination network.
    Extport string
    Incoming port number range that you want to map to a port number range on the destination network.
    Mappedips []string
    IP address or address range on the destination network to which the external IP address is mapped.
    Mappedport string
    Port number range on the destination network to which the external port number range is mapped.
    Name string
    Virtual IP name.
    Portforward string
    Enable/disable port forwarding.
    Protocol string
    Protocol to use when forwarding packets.
    comment String
    Comment.
    extintf String
    Interface connected to the source network that receives the packets that will be forwarded to the destination network.
    extip String
    IP address or address range on the external interface that you want to map to an address or address range on the destination network.
    extport String
    Incoming port number range that you want to map to a port number range on the destination network.
    mappedips List<String>
    IP address or address range on the destination network to which the external IP address is mapped.
    mappedport String
    Port number range on the destination network to which the external port number range is mapped.
    name String
    Virtual IP name.
    portforward String
    Enable/disable port forwarding.
    protocol String
    Protocol to use when forwarding packets.
    comment string
    Comment.
    extintf string
    Interface connected to the source network that receives the packets that will be forwarded to the destination network.
    extip string
    IP address or address range on the external interface that you want to map to an address or address range on the destination network.
    extport string
    Incoming port number range that you want to map to a port number range on the destination network.
    mappedips string[]
    IP address or address range on the destination network to which the external IP address is mapped.
    mappedport string
    Port number range on the destination network to which the external port number range is mapped.
    name string
    Virtual IP name.
    portforward string
    Enable/disable port forwarding.
    protocol string
    Protocol to use when forwarding packets.
    comment str
    Comment.
    extintf str
    Interface connected to the source network that receives the packets that will be forwarded to the destination network.
    extip str
    IP address or address range on the external interface that you want to map to an address or address range on the destination network.
    extport str
    Incoming port number range that you want to map to a port number range on the destination network.
    mappedips Sequence[str]
    IP address or address range on the destination network to which the external IP address is mapped.
    mappedport str
    Port number range on the destination network to which the external port number range is mapped.
    name str
    Virtual IP name.
    portforward str
    Enable/disable port forwarding.
    protocol str
    Protocol to use when forwarding packets.
    comment String
    Comment.
    extintf String
    Interface connected to the source network that receives the packets that will be forwarded to the destination network.
    extip String
    IP address or address range on the external interface that you want to map to an address or address range on the destination network.
    extport String
    Incoming port number range that you want to map to a port number range on the destination network.
    mappedips List<String>
    IP address or address range on the destination network to which the external IP address is mapped.
    mappedport String
    Port number range on the destination network to which the external port number range is mapped.
    name String
    Virtual IP name.
    portforward String
    Enable/disable port forwarding.
    protocol String
    Protocol to use when forwarding packets.

    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