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

fortios.firewall.Ippool

Explore with Pulumi AI

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

    Configure IPv4 IP pools.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as fortios from "@pulumiverse/fortios";
    
    const trname = new fortios.firewall.Ippool("trname", {
        arpReply: "enable",
        blockSize: 128,
        endip: "1.0.0.20",
        numBlocksPerUser: 8,
        pbaTimeout: 30,
        permitAnyHost: "disable",
        sourceEndip: "0.0.0.0",
        sourceStartip: "0.0.0.0",
        startip: "1.0.0.0",
        type: "overload",
    });
    
    import pulumi
    import pulumiverse_fortios as fortios
    
    trname = fortios.firewall.Ippool("trname",
        arp_reply="enable",
        block_size=128,
        endip="1.0.0.20",
        num_blocks_per_user=8,
        pba_timeout=30,
        permit_any_host="disable",
        source_endip="0.0.0.0",
        source_startip="0.0.0.0",
        startip="1.0.0.0",
        type="overload")
    
    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.NewIppool(ctx, "trname", &firewall.IppoolArgs{
    			ArpReply:         pulumi.String("enable"),
    			BlockSize:        pulumi.Int(128),
    			Endip:            pulumi.String("1.0.0.20"),
    			NumBlocksPerUser: pulumi.Int(8),
    			PbaTimeout:       pulumi.Int(30),
    			PermitAnyHost:    pulumi.String("disable"),
    			SourceEndip:      pulumi.String("0.0.0.0"),
    			SourceStartip:    pulumi.String("0.0.0.0"),
    			Startip:          pulumi.String("1.0.0.0"),
    			Type:             pulumi.String("overload"),
    		})
    		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.Firewall.Ippool("trname", new()
        {
            ArpReply = "enable",
            BlockSize = 128,
            Endip = "1.0.0.20",
            NumBlocksPerUser = 8,
            PbaTimeout = 30,
            PermitAnyHost = "disable",
            SourceEndip = "0.0.0.0",
            SourceStartip = "0.0.0.0",
            Startip = "1.0.0.0",
            Type = "overload",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.fortios.firewall.Ippool;
    import com.pulumi.fortios.firewall.IppoolArgs;
    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 Ippool("trname", IppoolArgs.builder()        
                .arpReply("enable")
                .blockSize(128)
                .endip("1.0.0.20")
                .numBlocksPerUser(8)
                .pbaTimeout(30)
                .permitAnyHost("disable")
                .sourceEndip("0.0.0.0")
                .sourceStartip("0.0.0.0")
                .startip("1.0.0.0")
                .type("overload")
                .build());
    
        }
    }
    
    resources:
      trname:
        type: fortios:firewall:Ippool
        properties:
          arpReply: enable
          blockSize: 128
          endip: 1.0.0.20
          numBlocksPerUser: 8
          pbaTimeout: 30
          permitAnyHost: disable
          sourceEndip: 0.0.0.0
          sourceStartip: 0.0.0.0
          startip: 1.0.0.0
          type: overload
    

    Create Ippool Resource

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

    Constructor syntax

    new Ippool(name: string, args: IppoolArgs, opts?: CustomResourceOptions);
    @overload
    def Ippool(resource_name: str,
               args: IppoolArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Ippool(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               endip: Optional[str] = None,
               startip: Optional[str] = None,
               num_blocks_per_user: Optional[int] = None,
               pba_timeout: Optional[int] = None,
               block_size: Optional[int] = None,
               comments: Optional[str] = None,
               arp_reply: Optional[str] = None,
               endport: Optional[int] = None,
               name: Optional[str] = None,
               nat64: Optional[str] = None,
               add_nat64_route: Optional[str] = None,
               associated_interface: Optional[str] = None,
               permit_any_host: Optional[str] = None,
               port_per_user: Optional[int] = None,
               source_endip: Optional[str] = None,
               source_startip: Optional[str] = None,
               arp_intf: Optional[str] = None,
               startport: Optional[int] = None,
               subnet_broadcast_in_ippool: Optional[str] = None,
               type: Optional[str] = None,
               vdomparam: Optional[str] = None)
    func NewIppool(ctx *Context, name string, args IppoolArgs, opts ...ResourceOption) (*Ippool, error)
    public Ippool(string name, IppoolArgs args, CustomResourceOptions? opts = null)
    public Ippool(String name, IppoolArgs args)
    public Ippool(String name, IppoolArgs args, CustomResourceOptions options)
    
    type: fortios:firewall:Ippool
    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 IppoolArgs
    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 IppoolArgs
    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 IppoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IppoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IppoolArgs
    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 ippoolResource = new Fortios.Firewall.Ippool("ippoolResource", new()
    {
        Endip = "string",
        Startip = "string",
        NumBlocksPerUser = 0,
        PbaTimeout = 0,
        BlockSize = 0,
        Comments = "string",
        ArpReply = "string",
        Endport = 0,
        Name = "string",
        Nat64 = "string",
        AddNat64Route = "string",
        AssociatedInterface = "string",
        PermitAnyHost = "string",
        PortPerUser = 0,
        SourceEndip = "string",
        SourceStartip = "string",
        ArpIntf = "string",
        Startport = 0,
        SubnetBroadcastInIppool = "string",
        Type = "string",
        Vdomparam = "string",
    });
    
    example, err := firewall.NewIppool(ctx, "ippoolResource", &firewall.IppoolArgs{
    	Endip:                   pulumi.String("string"),
    	Startip:                 pulumi.String("string"),
    	NumBlocksPerUser:        pulumi.Int(0),
    	PbaTimeout:              pulumi.Int(0),
    	BlockSize:               pulumi.Int(0),
    	Comments:                pulumi.String("string"),
    	ArpReply:                pulumi.String("string"),
    	Endport:                 pulumi.Int(0),
    	Name:                    pulumi.String("string"),
    	Nat64:                   pulumi.String("string"),
    	AddNat64Route:           pulumi.String("string"),
    	AssociatedInterface:     pulumi.String("string"),
    	PermitAnyHost:           pulumi.String("string"),
    	PortPerUser:             pulumi.Int(0),
    	SourceEndip:             pulumi.String("string"),
    	SourceStartip:           pulumi.String("string"),
    	ArpIntf:                 pulumi.String("string"),
    	Startport:               pulumi.Int(0),
    	SubnetBroadcastInIppool: pulumi.String("string"),
    	Type:                    pulumi.String("string"),
    	Vdomparam:               pulumi.String("string"),
    })
    
    var ippoolResource = new Ippool("ippoolResource", IppoolArgs.builder()
        .endip("string")
        .startip("string")
        .numBlocksPerUser(0)
        .pbaTimeout(0)
        .blockSize(0)
        .comments("string")
        .arpReply("string")
        .endport(0)
        .name("string")
        .nat64("string")
        .addNat64Route("string")
        .associatedInterface("string")
        .permitAnyHost("string")
        .portPerUser(0)
        .sourceEndip("string")
        .sourceStartip("string")
        .arpIntf("string")
        .startport(0)
        .subnetBroadcastInIppool("string")
        .type("string")
        .vdomparam("string")
        .build());
    
    ippool_resource = fortios.firewall.Ippool("ippoolResource",
        endip="string",
        startip="string",
        num_blocks_per_user=0,
        pba_timeout=0,
        block_size=0,
        comments="string",
        arp_reply="string",
        endport=0,
        name="string",
        nat64="string",
        add_nat64_route="string",
        associated_interface="string",
        permit_any_host="string",
        port_per_user=0,
        source_endip="string",
        source_startip="string",
        arp_intf="string",
        startport=0,
        subnet_broadcast_in_ippool="string",
        type="string",
        vdomparam="string")
    
    const ippoolResource = new fortios.firewall.Ippool("ippoolResource", {
        endip: "string",
        startip: "string",
        numBlocksPerUser: 0,
        pbaTimeout: 0,
        blockSize: 0,
        comments: "string",
        arpReply: "string",
        endport: 0,
        name: "string",
        nat64: "string",
        addNat64Route: "string",
        associatedInterface: "string",
        permitAnyHost: "string",
        portPerUser: 0,
        sourceEndip: "string",
        sourceStartip: "string",
        arpIntf: "string",
        startport: 0,
        subnetBroadcastInIppool: "string",
        type: "string",
        vdomparam: "string",
    });
    
    type: fortios:firewall:Ippool
    properties:
        addNat64Route: string
        arpIntf: string
        arpReply: string
        associatedInterface: string
        blockSize: 0
        comments: string
        endip: string
        endport: 0
        name: string
        nat64: string
        numBlocksPerUser: 0
        pbaTimeout: 0
        permitAnyHost: string
        portPerUser: 0
        sourceEndip: string
        sourceStartip: string
        startip: string
        startport: 0
        subnetBroadcastInIppool: string
        type: string
        vdomparam: string
    

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

    Endip string
    Final IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    Startip string
    First IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    AddNat64Route string
    Enable/disable adding NAT64 route. Valid values: disable, enable.
    ArpIntf string
    Select an interface from available options that will reply to ARP requests. (If blank, any is selected).
    ArpReply string
    Enable/disable replying to ARP requests when an IP Pool is added to a policy (default = enable). Valid values: disable, enable.
    AssociatedInterface string
    Associated interface name.
    BlockSize int
    Number of addresses in a block (64 - 4096, default = 128).
    Comments string
    Comment.
    Endport int
    Final port number (inclusive) in the range for the address pool (Default: 65533).
    Name string
    IP pool name.
    Nat64 string
    Enable/disable NAT64. Valid values: disable, enable.
    NumBlocksPerUser int
    Number of addresses blocks that can be used by a user (1 to 128, default = 8).
    PbaTimeout int
    Port block allocation timeout (seconds).
    PermitAnyHost string
    Enable/disable full cone NAT. Valid values: disable, enable.
    PortPerUser int
    Number of port for each user (32 - 60416, default = 0, which is auto).
    SourceEndip string
    Final IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    SourceStartip string
    First IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    Startport int
    First port number (inclusive) in the range for the address pool (Default: 5117).
    SubnetBroadcastInIppool string
    Enable/disable inclusion of the subnetwork address and broadcast IP address in the NAT64 IP pool. Valid values: disable, enable.
    Type string
    IP pool type. On FortiOS versions 6.2.0-7.4.1: overload, one-to-one, fixed port range, or port block allocation. On FortiOS versions >= 7.4.2: overload, one-to-one, fixed-port-range, port-block-allocation, cgn-resource-allocation (hyperscale vdom only). Valid values: overload, one-to-one, fixed-port-range, port-block-allocation.
    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.
    Endip string
    Final IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    Startip string
    First IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    AddNat64Route string
    Enable/disable adding NAT64 route. Valid values: disable, enable.
    ArpIntf string
    Select an interface from available options that will reply to ARP requests. (If blank, any is selected).
    ArpReply string
    Enable/disable replying to ARP requests when an IP Pool is added to a policy (default = enable). Valid values: disable, enable.
    AssociatedInterface string
    Associated interface name.
    BlockSize int
    Number of addresses in a block (64 - 4096, default = 128).
    Comments string
    Comment.
    Endport int
    Final port number (inclusive) in the range for the address pool (Default: 65533).
    Name string
    IP pool name.
    Nat64 string
    Enable/disable NAT64. Valid values: disable, enable.
    NumBlocksPerUser int
    Number of addresses blocks that can be used by a user (1 to 128, default = 8).
    PbaTimeout int
    Port block allocation timeout (seconds).
    PermitAnyHost string
    Enable/disable full cone NAT. Valid values: disable, enable.
    PortPerUser int
    Number of port for each user (32 - 60416, default = 0, which is auto).
    SourceEndip string
    Final IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    SourceStartip string
    First IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    Startport int
    First port number (inclusive) in the range for the address pool (Default: 5117).
    SubnetBroadcastInIppool string
    Enable/disable inclusion of the subnetwork address and broadcast IP address in the NAT64 IP pool. Valid values: disable, enable.
    Type string
    IP pool type. On FortiOS versions 6.2.0-7.4.1: overload, one-to-one, fixed port range, or port block allocation. On FortiOS versions >= 7.4.2: overload, one-to-one, fixed-port-range, port-block-allocation, cgn-resource-allocation (hyperscale vdom only). Valid values: overload, one-to-one, fixed-port-range, port-block-allocation.
    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.
    endip String
    Final IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    startip String
    First IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    addNat64Route String
    Enable/disable adding NAT64 route. Valid values: disable, enable.
    arpIntf String
    Select an interface from available options that will reply to ARP requests. (If blank, any is selected).
    arpReply String
    Enable/disable replying to ARP requests when an IP Pool is added to a policy (default = enable). Valid values: disable, enable.
    associatedInterface String
    Associated interface name.
    blockSize Integer
    Number of addresses in a block (64 - 4096, default = 128).
    comments String
    Comment.
    endport Integer
    Final port number (inclusive) in the range for the address pool (Default: 65533).
    name String
    IP pool name.
    nat64 String
    Enable/disable NAT64. Valid values: disable, enable.
    numBlocksPerUser Integer
    Number of addresses blocks that can be used by a user (1 to 128, default = 8).
    pbaTimeout Integer
    Port block allocation timeout (seconds).
    permitAnyHost String
    Enable/disable full cone NAT. Valid values: disable, enable.
    portPerUser Integer
    Number of port for each user (32 - 60416, default = 0, which is auto).
    sourceEndip String
    Final IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    sourceStartip String
    First IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    startport Integer
    First port number (inclusive) in the range for the address pool (Default: 5117).
    subnetBroadcastInIppool String
    Enable/disable inclusion of the subnetwork address and broadcast IP address in the NAT64 IP pool. Valid values: disable, enable.
    type String
    IP pool type. On FortiOS versions 6.2.0-7.4.1: overload, one-to-one, fixed port range, or port block allocation. On FortiOS versions >= 7.4.2: overload, one-to-one, fixed-port-range, port-block-allocation, cgn-resource-allocation (hyperscale vdom only). Valid values: overload, one-to-one, fixed-port-range, port-block-allocation.
    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.
    endip string
    Final IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    startip string
    First IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    addNat64Route string
    Enable/disable adding NAT64 route. Valid values: disable, enable.
    arpIntf string
    Select an interface from available options that will reply to ARP requests. (If blank, any is selected).
    arpReply string
    Enable/disable replying to ARP requests when an IP Pool is added to a policy (default = enable). Valid values: disable, enable.
    associatedInterface string
    Associated interface name.
    blockSize number
    Number of addresses in a block (64 - 4096, default = 128).
    comments string
    Comment.
    endport number
    Final port number (inclusive) in the range for the address pool (Default: 65533).
    name string
    IP pool name.
    nat64 string
    Enable/disable NAT64. Valid values: disable, enable.
    numBlocksPerUser number
    Number of addresses blocks that can be used by a user (1 to 128, default = 8).
    pbaTimeout number
    Port block allocation timeout (seconds).
    permitAnyHost string
    Enable/disable full cone NAT. Valid values: disable, enable.
    portPerUser number
    Number of port for each user (32 - 60416, default = 0, which is auto).
    sourceEndip string
    Final IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    sourceStartip string
    First IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    startport number
    First port number (inclusive) in the range for the address pool (Default: 5117).
    subnetBroadcastInIppool string
    Enable/disable inclusion of the subnetwork address and broadcast IP address in the NAT64 IP pool. Valid values: disable, enable.
    type string
    IP pool type. On FortiOS versions 6.2.0-7.4.1: overload, one-to-one, fixed port range, or port block allocation. On FortiOS versions >= 7.4.2: overload, one-to-one, fixed-port-range, port-block-allocation, cgn-resource-allocation (hyperscale vdom only). Valid values: overload, one-to-one, fixed-port-range, port-block-allocation.
    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.
    endip str
    Final IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    startip str
    First IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    add_nat64_route str
    Enable/disable adding NAT64 route. Valid values: disable, enable.
    arp_intf str
    Select an interface from available options that will reply to ARP requests. (If blank, any is selected).
    arp_reply str
    Enable/disable replying to ARP requests when an IP Pool is added to a policy (default = enable). Valid values: disable, enable.
    associated_interface str
    Associated interface name.
    block_size int
    Number of addresses in a block (64 - 4096, default = 128).
    comments str
    Comment.
    endport int
    Final port number (inclusive) in the range for the address pool (Default: 65533).
    name str
    IP pool name.
    nat64 str
    Enable/disable NAT64. Valid values: disable, enable.
    num_blocks_per_user int
    Number of addresses blocks that can be used by a user (1 to 128, default = 8).
    pba_timeout int
    Port block allocation timeout (seconds).
    permit_any_host str
    Enable/disable full cone NAT. Valid values: disable, enable.
    port_per_user int
    Number of port for each user (32 - 60416, default = 0, which is auto).
    source_endip str
    Final IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    source_startip str
    First IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    startport int
    First port number (inclusive) in the range for the address pool (Default: 5117).
    subnet_broadcast_in_ippool str
    Enable/disable inclusion of the subnetwork address and broadcast IP address in the NAT64 IP pool. Valid values: disable, enable.
    type str
    IP pool type. On FortiOS versions 6.2.0-7.4.1: overload, one-to-one, fixed port range, or port block allocation. On FortiOS versions >= 7.4.2: overload, one-to-one, fixed-port-range, port-block-allocation, cgn-resource-allocation (hyperscale vdom only). Valid values: overload, one-to-one, fixed-port-range, port-block-allocation.
    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.
    endip String
    Final IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    startip String
    First IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    addNat64Route String
    Enable/disable adding NAT64 route. Valid values: disable, enable.
    arpIntf String
    Select an interface from available options that will reply to ARP requests. (If blank, any is selected).
    arpReply String
    Enable/disable replying to ARP requests when an IP Pool is added to a policy (default = enable). Valid values: disable, enable.
    associatedInterface String
    Associated interface name.
    blockSize Number
    Number of addresses in a block (64 - 4096, default = 128).
    comments String
    Comment.
    endport Number
    Final port number (inclusive) in the range for the address pool (Default: 65533).
    name String
    IP pool name.
    nat64 String
    Enable/disable NAT64. Valid values: disable, enable.
    numBlocksPerUser Number
    Number of addresses blocks that can be used by a user (1 to 128, default = 8).
    pbaTimeout Number
    Port block allocation timeout (seconds).
    permitAnyHost String
    Enable/disable full cone NAT. Valid values: disable, enable.
    portPerUser Number
    Number of port for each user (32 - 60416, default = 0, which is auto).
    sourceEndip String
    Final IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    sourceStartip String
    First IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    startport Number
    First port number (inclusive) in the range for the address pool (Default: 5117).
    subnetBroadcastInIppool String
    Enable/disable inclusion of the subnetwork address and broadcast IP address in the NAT64 IP pool. Valid values: disable, enable.
    type String
    IP pool type. On FortiOS versions 6.2.0-7.4.1: overload, one-to-one, fixed port range, or port block allocation. On FortiOS versions >= 7.4.2: overload, one-to-one, fixed-port-range, port-block-allocation, cgn-resource-allocation (hyperscale vdom only). Valid values: overload, one-to-one, fixed-port-range, port-block-allocation.
    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 Ippool 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 Ippool Resource

    Get an existing Ippool 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?: IppoolState, opts?: CustomResourceOptions): Ippool
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            add_nat64_route: Optional[str] = None,
            arp_intf: Optional[str] = None,
            arp_reply: Optional[str] = None,
            associated_interface: Optional[str] = None,
            block_size: Optional[int] = None,
            comments: Optional[str] = None,
            endip: Optional[str] = None,
            endport: Optional[int] = None,
            name: Optional[str] = None,
            nat64: Optional[str] = None,
            num_blocks_per_user: Optional[int] = None,
            pba_timeout: Optional[int] = None,
            permit_any_host: Optional[str] = None,
            port_per_user: Optional[int] = None,
            source_endip: Optional[str] = None,
            source_startip: Optional[str] = None,
            startip: Optional[str] = None,
            startport: Optional[int] = None,
            subnet_broadcast_in_ippool: Optional[str] = None,
            type: Optional[str] = None,
            vdomparam: Optional[str] = None) -> Ippool
    func GetIppool(ctx *Context, name string, id IDInput, state *IppoolState, opts ...ResourceOption) (*Ippool, error)
    public static Ippool Get(string name, Input<string> id, IppoolState? state, CustomResourceOptions? opts = null)
    public static Ippool get(String name, Output<String> id, IppoolState 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:
    AddNat64Route string
    Enable/disable adding NAT64 route. Valid values: disable, enable.
    ArpIntf string
    Select an interface from available options that will reply to ARP requests. (If blank, any is selected).
    ArpReply string
    Enable/disable replying to ARP requests when an IP Pool is added to a policy (default = enable). Valid values: disable, enable.
    AssociatedInterface string
    Associated interface name.
    BlockSize int
    Number of addresses in a block (64 - 4096, default = 128).
    Comments string
    Comment.
    Endip string
    Final IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    Endport int
    Final port number (inclusive) in the range for the address pool (Default: 65533).
    Name string
    IP pool name.
    Nat64 string
    Enable/disable NAT64. Valid values: disable, enable.
    NumBlocksPerUser int
    Number of addresses blocks that can be used by a user (1 to 128, default = 8).
    PbaTimeout int
    Port block allocation timeout (seconds).
    PermitAnyHost string
    Enable/disable full cone NAT. Valid values: disable, enable.
    PortPerUser int
    Number of port for each user (32 - 60416, default = 0, which is auto).
    SourceEndip string
    Final IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    SourceStartip string
    First IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    Startip string
    First IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    Startport int
    First port number (inclusive) in the range for the address pool (Default: 5117).
    SubnetBroadcastInIppool string
    Enable/disable inclusion of the subnetwork address and broadcast IP address in the NAT64 IP pool. Valid values: disable, enable.
    Type string
    IP pool type. On FortiOS versions 6.2.0-7.4.1: overload, one-to-one, fixed port range, or port block allocation. On FortiOS versions >= 7.4.2: overload, one-to-one, fixed-port-range, port-block-allocation, cgn-resource-allocation (hyperscale vdom only). Valid values: overload, one-to-one, fixed-port-range, port-block-allocation.
    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.
    AddNat64Route string
    Enable/disable adding NAT64 route. Valid values: disable, enable.
    ArpIntf string
    Select an interface from available options that will reply to ARP requests. (If blank, any is selected).
    ArpReply string
    Enable/disable replying to ARP requests when an IP Pool is added to a policy (default = enable). Valid values: disable, enable.
    AssociatedInterface string
    Associated interface name.
    BlockSize int
    Number of addresses in a block (64 - 4096, default = 128).
    Comments string
    Comment.
    Endip string
    Final IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    Endport int
    Final port number (inclusive) in the range for the address pool (Default: 65533).
    Name string
    IP pool name.
    Nat64 string
    Enable/disable NAT64. Valid values: disable, enable.
    NumBlocksPerUser int
    Number of addresses blocks that can be used by a user (1 to 128, default = 8).
    PbaTimeout int
    Port block allocation timeout (seconds).
    PermitAnyHost string
    Enable/disable full cone NAT. Valid values: disable, enable.
    PortPerUser int
    Number of port for each user (32 - 60416, default = 0, which is auto).
    SourceEndip string
    Final IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    SourceStartip string
    First IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    Startip string
    First IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    Startport int
    First port number (inclusive) in the range for the address pool (Default: 5117).
    SubnetBroadcastInIppool string
    Enable/disable inclusion of the subnetwork address and broadcast IP address in the NAT64 IP pool. Valid values: disable, enable.
    Type string
    IP pool type. On FortiOS versions 6.2.0-7.4.1: overload, one-to-one, fixed port range, or port block allocation. On FortiOS versions >= 7.4.2: overload, one-to-one, fixed-port-range, port-block-allocation, cgn-resource-allocation (hyperscale vdom only). Valid values: overload, one-to-one, fixed-port-range, port-block-allocation.
    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.
    addNat64Route String
    Enable/disable adding NAT64 route. Valid values: disable, enable.
    arpIntf String
    Select an interface from available options that will reply to ARP requests. (If blank, any is selected).
    arpReply String
    Enable/disable replying to ARP requests when an IP Pool is added to a policy (default = enable). Valid values: disable, enable.
    associatedInterface String
    Associated interface name.
    blockSize Integer
    Number of addresses in a block (64 - 4096, default = 128).
    comments String
    Comment.
    endip String
    Final IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    endport Integer
    Final port number (inclusive) in the range for the address pool (Default: 65533).
    name String
    IP pool name.
    nat64 String
    Enable/disable NAT64. Valid values: disable, enable.
    numBlocksPerUser Integer
    Number of addresses blocks that can be used by a user (1 to 128, default = 8).
    pbaTimeout Integer
    Port block allocation timeout (seconds).
    permitAnyHost String
    Enable/disable full cone NAT. Valid values: disable, enable.
    portPerUser Integer
    Number of port for each user (32 - 60416, default = 0, which is auto).
    sourceEndip String
    Final IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    sourceStartip String
    First IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    startip String
    First IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    startport Integer
    First port number (inclusive) in the range for the address pool (Default: 5117).
    subnetBroadcastInIppool String
    Enable/disable inclusion of the subnetwork address and broadcast IP address in the NAT64 IP pool. Valid values: disable, enable.
    type String
    IP pool type. On FortiOS versions 6.2.0-7.4.1: overload, one-to-one, fixed port range, or port block allocation. On FortiOS versions >= 7.4.2: overload, one-to-one, fixed-port-range, port-block-allocation, cgn-resource-allocation (hyperscale vdom only). Valid values: overload, one-to-one, fixed-port-range, port-block-allocation.
    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.
    addNat64Route string
    Enable/disable adding NAT64 route. Valid values: disable, enable.
    arpIntf string
    Select an interface from available options that will reply to ARP requests. (If blank, any is selected).
    arpReply string
    Enable/disable replying to ARP requests when an IP Pool is added to a policy (default = enable). Valid values: disable, enable.
    associatedInterface string
    Associated interface name.
    blockSize number
    Number of addresses in a block (64 - 4096, default = 128).
    comments string
    Comment.
    endip string
    Final IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    endport number
    Final port number (inclusive) in the range for the address pool (Default: 65533).
    name string
    IP pool name.
    nat64 string
    Enable/disable NAT64. Valid values: disable, enable.
    numBlocksPerUser number
    Number of addresses blocks that can be used by a user (1 to 128, default = 8).
    pbaTimeout number
    Port block allocation timeout (seconds).
    permitAnyHost string
    Enable/disable full cone NAT. Valid values: disable, enable.
    portPerUser number
    Number of port for each user (32 - 60416, default = 0, which is auto).
    sourceEndip string
    Final IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    sourceStartip string
    First IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    startip string
    First IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    startport number
    First port number (inclusive) in the range for the address pool (Default: 5117).
    subnetBroadcastInIppool string
    Enable/disable inclusion of the subnetwork address and broadcast IP address in the NAT64 IP pool. Valid values: disable, enable.
    type string
    IP pool type. On FortiOS versions 6.2.0-7.4.1: overload, one-to-one, fixed port range, or port block allocation. On FortiOS versions >= 7.4.2: overload, one-to-one, fixed-port-range, port-block-allocation, cgn-resource-allocation (hyperscale vdom only). Valid values: overload, one-to-one, fixed-port-range, port-block-allocation.
    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.
    add_nat64_route str
    Enable/disable adding NAT64 route. Valid values: disable, enable.
    arp_intf str
    Select an interface from available options that will reply to ARP requests. (If blank, any is selected).
    arp_reply str
    Enable/disable replying to ARP requests when an IP Pool is added to a policy (default = enable). Valid values: disable, enable.
    associated_interface str
    Associated interface name.
    block_size int
    Number of addresses in a block (64 - 4096, default = 128).
    comments str
    Comment.
    endip str
    Final IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    endport int
    Final port number (inclusive) in the range for the address pool (Default: 65533).
    name str
    IP pool name.
    nat64 str
    Enable/disable NAT64. Valid values: disable, enable.
    num_blocks_per_user int
    Number of addresses blocks that can be used by a user (1 to 128, default = 8).
    pba_timeout int
    Port block allocation timeout (seconds).
    permit_any_host str
    Enable/disable full cone NAT. Valid values: disable, enable.
    port_per_user int
    Number of port for each user (32 - 60416, default = 0, which is auto).
    source_endip str
    Final IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    source_startip str
    First IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    startip str
    First IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    startport int
    First port number (inclusive) in the range for the address pool (Default: 5117).
    subnet_broadcast_in_ippool str
    Enable/disable inclusion of the subnetwork address and broadcast IP address in the NAT64 IP pool. Valid values: disable, enable.
    type str
    IP pool type. On FortiOS versions 6.2.0-7.4.1: overload, one-to-one, fixed port range, or port block allocation. On FortiOS versions >= 7.4.2: overload, one-to-one, fixed-port-range, port-block-allocation, cgn-resource-allocation (hyperscale vdom only). Valid values: overload, one-to-one, fixed-port-range, port-block-allocation.
    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.
    addNat64Route String
    Enable/disable adding NAT64 route. Valid values: disable, enable.
    arpIntf String
    Select an interface from available options that will reply to ARP requests. (If blank, any is selected).
    arpReply String
    Enable/disable replying to ARP requests when an IP Pool is added to a policy (default = enable). Valid values: disable, enable.
    associatedInterface String
    Associated interface name.
    blockSize Number
    Number of addresses in a block (64 - 4096, default = 128).
    comments String
    Comment.
    endip String
    Final IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    endport Number
    Final port number (inclusive) in the range for the address pool (Default: 65533).
    name String
    IP pool name.
    nat64 String
    Enable/disable NAT64. Valid values: disable, enable.
    numBlocksPerUser Number
    Number of addresses blocks that can be used by a user (1 to 128, default = 8).
    pbaTimeout Number
    Port block allocation timeout (seconds).
    permitAnyHost String
    Enable/disable full cone NAT. Valid values: disable, enable.
    portPerUser Number
    Number of port for each user (32 - 60416, default = 0, which is auto).
    sourceEndip String
    Final IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    sourceStartip String
    First IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    startip String
    First IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
    startport Number
    First port number (inclusive) in the range for the address pool (Default: 5117).
    subnetBroadcastInIppool String
    Enable/disable inclusion of the subnetwork address and broadcast IP address in the NAT64 IP pool. Valid values: disable, enable.
    type String
    IP pool type. On FortiOS versions 6.2.0-7.4.1: overload, one-to-one, fixed port range, or port block allocation. On FortiOS versions >= 7.4.2: overload, one-to-one, fixed-port-range, port-block-allocation, cgn-resource-allocation (hyperscale vdom only). Valid values: overload, one-to-one, fixed-port-range, port-block-allocation.
    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.

    Import

    Firewall Ippool can be imported using any of these accepted formats:

    $ pulumi import fortios:firewall/ippool:Ippool labelname {{name}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:firewall/ippool:Ippool 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