PortForwarding

Freebox v0.3.11, Jul 3 26

Viewing docs for Freebox v0.3.11
published on Friday, Jul 3, 2026 by OlivierPaquien

Schema (JSON)

OlivierPaquien/pulumi-freebox

Viewing docs for Freebox v0.3.11
published on Friday, Jul 3, 2026 by OlivierPaquien

Schema (JSON)

OlivierPaquien/pulumi-freebox

Create PortForwarding Resource

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

Constructor syntax

new PortForwarding(name: string, args: PortForwardingArgs, opts?: CustomResourceOptions);

@overload
def PortForwarding(resource_name: str,
                   args: PortForwardingArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def PortForwarding(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   enabled: Optional[bool] = None,
                   ip_protocol: Optional[str] = None,
                   port_range_start: Optional[int] = None,
                   target_ip: Optional[str] = None,
                   comment: Optional[str] = None,
                   port_range_end: Optional[int] = None,
                   source_ip: Optional[str] = None,
                   target_port: Optional[int] = None)

func NewPortForwarding(ctx *Context, name string, args PortForwardingArgs, opts ...ResourceOption) (*PortForwarding, error)

public PortForwarding(string name, PortForwardingArgs args, CustomResourceOptions? opts = null)

public PortForwarding(String name, PortForwardingArgs args)
public PortForwarding(String name, PortForwardingArgs args, CustomResourceOptions options)

type: freebox:fw:PortForwarding
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

resource "freebox_fw_portforwarding" "name" {
    # resource properties
}

Parameters

name string: The unique name of the resource.
args PortForwardingArgs: 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 PortForwardingArgs: 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 PortForwardingArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args PortForwardingArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args PortForwardingArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

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

var portForwardingResource = new Freebox.Fw.PortForwarding("portForwardingResource", new()
{
    Enabled = false,
    IpProtocol = "string",
    PortRangeStart = 0,
    TargetIp = "string",
    Comment = "string",
    PortRangeEnd = 0,
    SourceIp = "string",
    TargetPort = 0,
});

example, err := fw.NewPortForwarding(ctx, "portForwardingResource", &fw.PortForwardingArgs{
	Enabled:        pulumi.Bool(false),
	IpProtocol:     pulumi.String("string"),
	PortRangeStart: pulumi.Int(0),
	TargetIp:       pulumi.String("string"),
	Comment:        pulumi.String("string"),
	PortRangeEnd:   pulumi.Int(0),
	SourceIp:       pulumi.String("string"),
	TargetPort:     pulumi.Int(0),
})

resource "freebox_fw_portforwarding" "portForwardingResource" {
  enabled          = false
  ip_protocol      = "string"
  port_range_start = 0
  target_ip        = "string"
  comment          = "string"
  port_range_end   = 0
  source_ip        = "string"
  target_port      = 0
}

var portForwardingResource = new PortForwarding("portForwardingResource", PortForwardingArgs.builder()
    .enabled(false)
    .ipProtocol("string")
    .portRangeStart(0)
    .targetIp("string")
    .comment("string")
    .portRangeEnd(0)
    .sourceIp("string")
    .targetPort(0)
    .build());

port_forwarding_resource = freebox.fw.PortForwarding("portForwardingResource",
    enabled=False,
    ip_protocol="string",
    port_range_start=0,
    target_ip="string",
    comment="string",
    port_range_end=0,
    source_ip="string",
    target_port=0)

const portForwardingResource = new freebox.fw.PortForwarding("portForwardingResource", {
    enabled: false,
    ipProtocol: "string",
    portRangeStart: 0,
    targetIp: "string",
    comment: "string",
    portRangeEnd: 0,
    sourceIp: "string",
    targetPort: 0,
});

type: freebox:fw:PortForwarding
properties:
    comment: string
    enabled: false
    ipProtocol: string
    portRangeEnd: 0
    portRangeStart: 0
    sourceIp: string
    targetIp: string
    targetPort: 0

PortForwarding Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The PortForwarding resource accepts the following input properties:

Enabled bool: Whether the forwarding is enabled.
IpProtocol string: Protocol: tcp or udp.
PortRangeStart int: Start of the WAN port range (inclusive).
TargetIp string: Local IP of the port forwarding target.
Comment string: Optional comment for the rule.
PortRangeEnd int: End of the WAN port range (defaults to portRangeStart).
SourceIp string: Source IP filter (0.0.0.0 = any).
TargetPort int: Target LAN port (defaults to portRangeStart when range is a single port).

Enabled bool: Whether the forwarding is enabled.
IpProtocol string: Protocol: tcp or udp.
PortRangeStart int: Start of the WAN port range (inclusive).
TargetIp string: Local IP of the port forwarding target.
Comment string: Optional comment for the rule.
PortRangeEnd int: End of the WAN port range (defaults to portRangeStart).
SourceIp string: Source IP filter (0.0.0.0 = any).
TargetPort int: Target LAN port (defaults to portRangeStart when range is a single port).

enabled bool: Whether the forwarding is enabled.
ip_protocol string: Protocol: tcp or udp.
port_range_start number: Start of the WAN port range (inclusive).
target_ip string: Local IP of the port forwarding target.
comment string: Optional comment for the rule.
port_range_end number: End of the WAN port range (defaults to portRangeStart).
source_ip string: Source IP filter (0.0.0.0 = any).
target_port number: Target LAN port (defaults to portRangeStart when range is a single port).

enabled Boolean: Whether the forwarding is enabled.
ipProtocol String: Protocol: tcp or udp.
portRangeStart Integer: Start of the WAN port range (inclusive).
targetIp String: Local IP of the port forwarding target.
comment String: Optional comment for the rule.
portRangeEnd Integer: End of the WAN port range (defaults to portRangeStart).
sourceIp String: Source IP filter (0.0.0.0 = any).
targetPort Integer: Target LAN port (defaults to portRangeStart when range is a single port).

enabled boolean: Whether the forwarding is enabled.
ipProtocol string: Protocol: tcp or udp.
portRangeStart number: Start of the WAN port range (inclusive).
targetIp string: Local IP of the port forwarding target.
comment string: Optional comment for the rule.
portRangeEnd number: End of the WAN port range (defaults to portRangeStart).
sourceIp string: Source IP filter (0.0.0.0 = any).
targetPort number: Target LAN port (defaults to portRangeStart when range is a single port).

enabled bool: Whether the forwarding is enabled.
ip_protocol str: Protocol: tcp or udp.
port_range_start int: Start of the WAN port range (inclusive).
target_ip str: Local IP of the port forwarding target.
comment str: Optional comment for the rule.
port_range_end int: End of the WAN port range (defaults to portRangeStart).
source_ip str: Source IP filter (0.0.0.0 = any).
target_port int: Target LAN port (defaults to portRangeStart when range is a single port).

enabled Boolean: Whether the forwarding is enabled.
ipProtocol String: Protocol: tcp or udp.
portRangeStart Number: Start of the WAN port range (inclusive).
targetIp String: Local IP of the port forwarding target.
comment String: Optional comment for the rule.
portRangeEnd Number: End of the WAN port range (defaults to portRangeStart).
sourceIp String: Source IP filter (0.0.0.0 = any).
targetPort Number: Target LAN port (defaults to portRangeStart when range is a single port).

Outputs

All input properties are implicitly available as output properties. Additionally, the PortForwarding resource produces the following output properties:

Hostname string: Hostname reported by the Freebox for this rule.
Id string: The provider-assigned unique ID for this managed resource.
RuleId int: Freebox API rule ID.
Host OlivierPaquien.Pulumi.Freebox.Outputs.LanHost: LAN host information for the target.

Hostname string: Hostname reported by the Freebox for this rule.
Id string: The provider-assigned unique ID for this managed resource.
RuleId int: Freebox API rule ID.
Host LanHost: LAN host information for the target.