Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Checkpoint Provider
  4. API Docs
  5. GaiaPppoeInterface
Viewing docs for checkpoint 3.2.0
published on Monday, Jun 15, 2026 by checkpointsw
Schema (JSON)
checkpointsw/terraform-provider-checkpoint

checkpoint.GaiaPppoeInterface

Viewing docs for checkpoint 3.2.0
published on Monday, Jun 15, 2026 by checkpointsw
Schema (JSON)
checkpointsw/terraform-provider-checkpoint

    This resource allows you to execute Check Point Pppoe Interface.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as checkpoint from "@pulumi/checkpoint";

const example = new checkpoint.GaiaPppoeInterface("example", {
    clientId: 1,
    "interface": "eth0",
    username: "admin",
    password: "password",
    usePeerAsDefaultGateway: true,
    usePeerDns: true,
    comments: "example pppoe interface",
    enabled: true,
});

    import pulumi
import pulumi_checkpoint as checkpoint

example = checkpoint.GaiaPppoeInterface("example",
    client_id=1,
    interface="eth0",
    username="admin",
    password="password",
    use_peer_as_default_gateway=True,
    use_peer_dns=True,
    comments="example pppoe interface",
    enabled=True)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/checkpoint/v3/checkpoint"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := checkpoint.NewGaiaPppoeInterface(ctx, "example", &checkpoint.GaiaPppoeInterfaceArgs{
			ClientId:                pulumi.Float64(1),
			Interface:               pulumi.String("eth0"),
			Username:                pulumi.String("admin"),
			Password:                pulumi.String("password"),
			UsePeerAsDefaultGateway: pulumi.Bool(true),
			UsePeerDns:              pulumi.Bool(true),
			Comments:                pulumi.String("example pppoe interface"),
			Enabled:                 pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Checkpoint = Pulumi.Checkpoint;

return await Deployment.RunAsync(() => 
{
    var example = new Checkpoint.GaiaPppoeInterface("example", new()
    {
        ClientId = 1,
        Interface = "eth0",
        Username = "admin",
        Password = "password",
        UsePeerAsDefaultGateway = true,
        UsePeerDns = true,
        Comments = "example pppoe interface",
        Enabled = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.checkpoint.GaiaPppoeInterface;
import com.pulumi.checkpoint.GaiaPppoeInterfaceArgs;
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 example = new GaiaPppoeInterface("example", GaiaPppoeInterfaceArgs.builder()
            .clientId(1.0)
            .interface_("eth0")
            .username("admin")
            .password("password")
            .usePeerAsDefaultGateway(true)
            .usePeerDns(true)
            .comments("example pppoe interface")
            .enabled(true)
            .build());

    }
}

    resources:
  example:
    type: checkpoint:GaiaPppoeInterface
    properties:
      clientId: 1
      interface: eth0
      username: admin
      password: password
      usePeerAsDefaultGateway: true
      usePeerDns: true
      comments: example pppoe interface
      enabled: true

    Example coming soon!

    Create GaiaPppoeInterface Resource

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

    Constructor syntax

    new GaiaPppoeInterface(name: string, args: GaiaPppoeInterfaceArgs, opts?: CustomResourceOptions);
    @overload
def GaiaPppoeInterface(resource_name: str,
                       args: GaiaPppoeInterfaceArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def GaiaPppoeInterface(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       client_id: Optional[float] = None,
                       username: Optional[str] = None,
                       interface: Optional[str] = None,
                       enabled: Optional[bool] = None,
                       fake_peer_settings: Optional[GaiaPppoeInterfaceFakePeerSettingsArgs] = None,
                       gaia_pppoe_interface_id: Optional[str] = None,
                       debug: Optional[bool] = None,
                       member_id: Optional[str] = None,
                       password: Optional[str] = None,
                       password_hash: Optional[str] = None,
                       sd_wan: Optional[GaiaPppoeInterfaceSdWanArgs] = None,
                       use_peer_as_default_gateway: Optional[bool] = None,
                       use_peer_dns: Optional[bool] = None,
                       comments: Optional[str] = None)
    func NewGaiaPppoeInterface(ctx *Context, name string, args GaiaPppoeInterfaceArgs, opts ...ResourceOption) (*GaiaPppoeInterface, error)
    public GaiaPppoeInterface(string name, GaiaPppoeInterfaceArgs args, CustomResourceOptions? opts = null)
    public GaiaPppoeInterface(String name, GaiaPppoeInterfaceArgs args)
public GaiaPppoeInterface(String name, GaiaPppoeInterfaceArgs args, CustomResourceOptions options)

    type: checkpoint:GaiaPppoeInterface
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "checkpoint_gaiapppoeinterface" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args GaiaPppoeInterfaceArgs
    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 GaiaPppoeInterfaceArgs
    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 GaiaPppoeInterfaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GaiaPppoeInterfaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GaiaPppoeInterfaceArgs
    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 gaiaPppoeInterfaceResource = new Checkpoint.GaiaPppoeInterface("gaiaPppoeInterfaceResource", new()
{
    ClientId = 0,
    Username = "string",
    Interface = "string",
    Enabled = false,
    FakePeerSettings = new Checkpoint.Inputs.GaiaPppoeInterfaceFakePeerSettingsArgs
    {
        Address = "string",
        Enabled = false,
    },
    GaiaPppoeInterfaceId = "string",
    Debug = false,
    MemberId = "string",
    Password = "string",
    PasswordHash = "string",
    SdWan = new Checkpoint.Inputs.GaiaPppoeInterfaceSdWanArgs
    {
        Bandwidth = new Checkpoint.Inputs.GaiaPppoeInterfaceSdWanBandwidthArgs
        {
            DownloadSpeed = "string",
            UploadSpeed = "string",
        },
        CircuitId = "string",
        Enabled = false,
        Nat = new Checkpoint.Inputs.GaiaPppoeInterfaceSdWanNatArgs
        {
            Enabled = false,
            Ip = "string",
            Ipv6 = "string",
        },
        NextHop = "string",
        NextHopIpv6 = "string",
        Tag = "string",
    },
    UsePeerAsDefaultGateway = false,
    UsePeerDns = false,
    Comments = "string",
});

    example, err := checkpoint.NewGaiaPppoeInterface(ctx, "gaiaPppoeInterfaceResource", &checkpoint.GaiaPppoeInterfaceArgs{
	ClientId:  pulumi.Float64(0),
	Username:  pulumi.String("string"),
	Interface: pulumi.String("string"),
	Enabled:   pulumi.Bool(false),
	FakePeerSettings: &checkpoint.GaiaPppoeInterfaceFakePeerSettingsArgs{
		Address: pulumi.String("string"),
		Enabled: pulumi.Bool(false),
	},
	GaiaPppoeInterfaceId: pulumi.String("string"),
	Debug:                pulumi.Bool(false),
	MemberId:             pulumi.String("string"),
	Password:             pulumi.String("string"),
	PasswordHash:         pulumi.String("string"),
	SdWan: &checkpoint.GaiaPppoeInterfaceSdWanArgs{
		Bandwidth: &checkpoint.GaiaPppoeInterfaceSdWanBandwidthArgs{
			DownloadSpeed: pulumi.String("string"),
			UploadSpeed:   pulumi.String("string"),
		},
		CircuitId: pulumi.String("string"),
		Enabled:   pulumi.Bool(false),
		Nat: &checkpoint.GaiaPppoeInterfaceSdWanNatArgs{
			Enabled: pulumi.Bool(false),
			Ip:      pulumi.String("string"),
			Ipv6:    pulumi.String("string"),
		},
		NextHop:     pulumi.String("string"),
		NextHopIpv6: pulumi.String("string"),
		Tag:         pulumi.String("string"),
	},
	UsePeerAsDefaultGateway: pulumi.Bool(false),
	UsePeerDns:              pulumi.Bool(false),
	Comments:                pulumi.String("string"),
})

    resource "checkpoint_gaiapppoeinterface" "gaiaPppoeInterfaceResource" {
  client_id = 0
  username  = "string"
  interface = "string"
  enabled   = false
  fake_peer_settings = {
    address = "string"
    enabled = false
  }
  gaia_pppoe_interface_id = "string"
  debug                   = false
  member_id               = "string"
  password                = "string"
  password_hash           = "string"
  sd_wan = {
    bandwidth = {
      download_speed = "string"
      upload_speed   = "string"
    }
    circuit_id = "string"
    enabled    = false
    nat = {
      enabled = false
      ip      = "string"
      ipv6    = "string"
    }
    next_hop      = "string"
    next_hop_ipv6 = "string"
    tag           = "string"
  }
  use_peer_as_default_gateway = false
  use_peer_dns                = false
  comments                    = "string"
}

    var gaiaPppoeInterfaceResource = new GaiaPppoeInterface("gaiaPppoeInterfaceResource", GaiaPppoeInterfaceArgs.builder()
    .clientId(0.0)
    .username("string")
    .interface_("string")
    .enabled(false)
    .fakePeerSettings(GaiaPppoeInterfaceFakePeerSettingsArgs.builder()
        .address("string")
        .enabled(false)
        .build())
    .gaiaPppoeInterfaceId("string")
    .debug(false)
    .memberId("string")
    .password("string")
    .passwordHash("string")
    .sdWan(GaiaPppoeInterfaceSdWanArgs.builder()
        .bandwidth(GaiaPppoeInterfaceSdWanBandwidthArgs.builder()
            .downloadSpeed("string")
            .uploadSpeed("string")
            .build())
        .circuitId("string")
        .enabled(false)
        .nat(GaiaPppoeInterfaceSdWanNatArgs.builder()
            .enabled(false)
            .ip("string")
            .ipv6("string")
            .build())
        .nextHop("string")
        .nextHopIpv6("string")
        .tag("string")
        .build())
    .usePeerAsDefaultGateway(false)
    .usePeerDns(false)
    .comments("string")
    .build());

    gaia_pppoe_interface_resource = checkpoint.GaiaPppoeInterface("gaiaPppoeInterfaceResource",
    client_id=float(0),
    username="string",
    interface="string",
    enabled=False,
    fake_peer_settings={
        "address": "string",
        "enabled": False,
    },
    gaia_pppoe_interface_id="string",
    debug=False,
    member_id="string",
    password="string",
    password_hash="string",
    sd_wan={
        "bandwidth": {
            "download_speed": "string",
            "upload_speed": "string",
        },
        "circuit_id": "string",
        "enabled": False,
        "nat": {
            "enabled": False,
            "ip": "string",
            "ipv6": "string",
        },
        "next_hop": "string",
        "next_hop_ipv6": "string",
        "tag": "string",
    },
    use_peer_as_default_gateway=False,
    use_peer_dns=False,
    comments="string")

    const gaiaPppoeInterfaceResource = new checkpoint.GaiaPppoeInterface("gaiaPppoeInterfaceResource", {
    clientId: 0,
    username: "string",
    "interface": "string",
    enabled: false,
    fakePeerSettings: {
        address: "string",
        enabled: false,
    },
    gaiaPppoeInterfaceId: "string",
    debug: false,
    memberId: "string",
    password: "string",
    passwordHash: "string",
    sdWan: {
        bandwidth: {
            downloadSpeed: "string",
            uploadSpeed: "string",
        },
        circuitId: "string",
        enabled: false,
        nat: {
            enabled: false,
            ip: "string",
            ipv6: "string",
        },
        nextHop: "string",
        nextHopIpv6: "string",
        tag: "string",
    },
    usePeerAsDefaultGateway: false,
    usePeerDns: false,
    comments: "string",
});

    type: checkpoint:GaiaPppoeInterface
properties:
    clientId: 0
    comments: string
    debug: false
    enabled: false
    fakePeerSettings:
        address: string
        enabled: false
    gaiaPppoeInterfaceId: string
    interface: string
    memberId: string
    password: string
    passwordHash: string
    sdWan:
        bandwidth:
            downloadSpeed: string
            uploadSpeed: string
        circuitId: string
        enabled: false
        nat:
            enabled: false
            ip: string
            ipv6: string
        nextHop: string
        nextHopIpv6: string
        tag: string
    usePeerAsDefaultGateway: false
    usePeerDns: false
    username: string

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

    ClientId double
    The PPPoE client Id. This ID must be unique for every PPPoE interface.
    Interface string
    The name of the applicable physical interface. Gaia uses this interface to forward PPPoE frames.
    Username string
    The username needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP
    Comments string
    User comments.
    Debug bool
    Enable debug logging for this resource.
    Enabled bool
    Enable to turn on the interface.
    FakePeerSettings GaiaPppoeInterfaceFakePeerSettings
    Fake peer settings fake_peer_settings blocks are documented below.
    GaiaPppoeInterfaceId string
    MemberId string
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    Password string
    The password needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP
    PasswordHash string
    The hash of the password needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP.
    SdWan GaiaPppoeInterfaceSdWan
    SD-WAN configuration. Supported starting from R81.20 JHF 14 sd_wan blocks are documented below.
    UsePeerAsDefaultGateway bool
    Enable to make the ISP server the Default Gateway for the Gaia.
    UsePeerDns bool
    Enable to allow the ISP to define the IPv4 DNS server for the Gaia.
    ClientId float64
    The PPPoE client Id. This ID must be unique for every PPPoE interface.
    Interface string
    The name of the applicable physical interface. Gaia uses this interface to forward PPPoE frames.
    Username string
    The username needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP
    Comments string
    User comments.
    Debug bool
    Enable debug logging for this resource.
    Enabled bool
    Enable to turn on the interface.
    FakePeerSettings GaiaPppoeInterfaceFakePeerSettingsArgs
    Fake peer settings fake_peer_settings blocks are documented below.
    GaiaPppoeInterfaceId string
    MemberId string
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    Password string
    The password needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP
    PasswordHash string
    The hash of the password needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP.
    SdWan GaiaPppoeInterfaceSdWanArgs
    SD-WAN configuration. Supported starting from R81.20 JHF 14 sd_wan blocks are documented below.
    UsePeerAsDefaultGateway bool
    Enable to make the ISP server the Default Gateway for the Gaia.
    UsePeerDns bool
    Enable to allow the ISP to define the IPv4 DNS server for the Gaia.
    client_id number
    The PPPoE client Id. This ID must be unique for every PPPoE interface.
    interface string
    The name of the applicable physical interface. Gaia uses this interface to forward PPPoE frames.
    username string
    The username needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP
    comments string
    User comments.
    debug bool
    Enable debug logging for this resource.
    enabled bool
    Enable to turn on the interface.
    fake_peer_settings object
    Fake peer settings fake_peer_settings blocks are documented below.
    gaia_pppoe_interface_id string
    member_id string
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    password string
    The password needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP
    password_hash string
    The hash of the password needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP.
    sd_wan object
    SD-WAN configuration. Supported starting from R81.20 JHF 14 sd_wan blocks are documented below.
    use_peer_as_default_gateway bool
    Enable to make the ISP server the Default Gateway for the Gaia.
    use_peer_dns bool
    Enable to allow the ISP to define the IPv4 DNS server for the Gaia.
    clientId Double
    The PPPoE client Id. This ID must be unique for every PPPoE interface.
    interface_ String
    The name of the applicable physical interface. Gaia uses this interface to forward PPPoE frames.
    username String
    The username needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP
    comments String
    User comments.
    debug Boolean
    Enable debug logging for this resource.
    enabled Boolean
    Enable to turn on the interface.
    fakePeerSettings GaiaPppoeInterfaceFakePeerSettings
    Fake peer settings fake_peer_settings blocks are documented below.
    gaiaPppoeInterfaceId String
    memberId String
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    password String
    The password needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP
    passwordHash String
    The hash of the password needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP.
    sdWan GaiaPppoeInterfaceSdWan
    SD-WAN configuration. Supported starting from R81.20 JHF 14 sd_wan blocks are documented below.
    usePeerAsDefaultGateway Boolean
    Enable to make the ISP server the Default Gateway for the Gaia.
    usePeerDns Boolean
    Enable to allow the ISP to define the IPv4 DNS server for the Gaia.
    clientId number
    The PPPoE client Id. This ID must be unique for every PPPoE interface.
    interface string
    The name of the applicable physical interface. Gaia uses this interface to forward PPPoE frames.
    username string
    The username needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP
    comments string
    User comments.
    debug boolean
    Enable debug logging for this resource.
    enabled boolean
    Enable to turn on the interface.
    fakePeerSettings GaiaPppoeInterfaceFakePeerSettings
    Fake peer settings fake_peer_settings blocks are documented below.
    gaiaPppoeInterfaceId string
    memberId string
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    password string
    The password needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP
    passwordHash string
    The hash of the password needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP.
    sdWan GaiaPppoeInterfaceSdWan
    SD-WAN configuration. Supported starting from R81.20 JHF 14 sd_wan blocks are documented below.
    usePeerAsDefaultGateway boolean
    Enable to make the ISP server the Default Gateway for the Gaia.
    usePeerDns boolean
    Enable to allow the ISP to define the IPv4 DNS server for the Gaia.
    client_id float
    The PPPoE client Id. This ID must be unique for every PPPoE interface.
    interface str
    The name of the applicable physical interface. Gaia uses this interface to forward PPPoE frames.
    username str
    The username needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP
    comments str
    User comments.
    debug bool
    Enable debug logging for this resource.
    enabled bool
    Enable to turn on the interface.
    fake_peer_settings GaiaPppoeInterfaceFakePeerSettingsArgs
    Fake peer settings fake_peer_settings blocks are documented below.
    gaia_pppoe_interface_id str
    member_id str
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    password str
    The password needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP
    password_hash str
    The hash of the password needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP.
    sd_wan GaiaPppoeInterfaceSdWanArgs
    SD-WAN configuration. Supported starting from R81.20 JHF 14 sd_wan blocks are documented below.
    use_peer_as_default_gateway bool
    Enable to make the ISP server the Default Gateway for the Gaia.
    use_peer_dns bool
    Enable to allow the ISP to define the IPv4 DNS server for the Gaia.
    clientId Number
    The PPPoE client Id. This ID must be unique for every PPPoE interface.
    interface String
    The name of the applicable physical interface. Gaia uses this interface to forward PPPoE frames.
    username String
    The username needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP
    comments String
    User comments.
    debug Boolean
    Enable debug logging for this resource.
    enabled Boolean
    Enable to turn on the interface.
    fakePeerSettings Property Map
    Fake peer settings fake_peer_settings blocks are documented below.
    gaiaPppoeInterfaceId String
    memberId String
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    password String
    The password needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP
    passwordHash String
    The hash of the password needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP.
    sdWan Property Map
    SD-WAN configuration. Supported starting from R81.20 JHF 14 sd_wan blocks are documented below.
    usePeerAsDefaultGateway Boolean
    Enable to make the ISP server the Default Gateway for the Gaia.
    usePeerDns Boolean
    Enable to allow the ISP to define the IPv4 DNS server for the Gaia.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The PPPoE interface name.
    Status string
    Computed field, returned in the response.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The PPPoE interface name.
    Status string
    Computed field, returned in the response.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The PPPoE interface name.
    status string
    Computed field, returned in the response.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The PPPoE interface name.
    status String
    Computed field, returned in the response.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The PPPoE interface name.
    status string
    Computed field, returned in the response.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The PPPoE interface name.
    status str
    Computed field, returned in the response.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The PPPoE interface name.
    status String
    Computed field, returned in the response.

    Look up Existing GaiaPppoeInterface Resource

    Get an existing GaiaPppoeInterface 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?: GaiaPppoeInterfaceState, opts?: CustomResourceOptions): GaiaPppoeInterface
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        client_id: Optional[float] = None,
        comments: Optional[str] = None,
        debug: Optional[bool] = None,
        enabled: Optional[bool] = None,
        fake_peer_settings: Optional[GaiaPppoeInterfaceFakePeerSettingsArgs] = None,
        gaia_pppoe_interface_id: Optional[str] = None,
        interface: Optional[str] = None,
        member_id: Optional[str] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        password_hash: Optional[str] = None,
        sd_wan: Optional[GaiaPppoeInterfaceSdWanArgs] = None,
        status: Optional[str] = None,
        use_peer_as_default_gateway: Optional[bool] = None,
        use_peer_dns: Optional[bool] = None,
        username: Optional[str] = None) -> GaiaPppoeInterface
    func GetGaiaPppoeInterface(ctx *Context, name string, id IDInput, state *GaiaPppoeInterfaceState, opts ...ResourceOption) (*GaiaPppoeInterface, error)
    public static GaiaPppoeInterface Get(string name, Input<string> id, GaiaPppoeInterfaceState? state, CustomResourceOptions? opts = null)
    public static GaiaPppoeInterface get(String name, Output<String> id, GaiaPppoeInterfaceState state, CustomResourceOptions options)
    resources:  _:    type: checkpoint:GaiaPppoeInterface    get:      id: ${id}
    import {
  to = checkpoint_gaiapppoeinterface.example
  id = "${id}"
}
    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:
    ClientId double
    The PPPoE client Id. This ID must be unique for every PPPoE interface.
    Comments string
    User comments.
    Debug bool
    Enable debug logging for this resource.
    Enabled bool
    Enable to turn on the interface.
    FakePeerSettings GaiaPppoeInterfaceFakePeerSettings
    Fake peer settings fake_peer_settings blocks are documented below.
    GaiaPppoeInterfaceId string
    Interface string
    The name of the applicable physical interface. Gaia uses this interface to forward PPPoE frames.
    MemberId string
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    Name string
    The PPPoE interface name.
    Password string
    The password needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP
    PasswordHash string
    The hash of the password needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP.
    SdWan GaiaPppoeInterfaceSdWan
    SD-WAN configuration. Supported starting from R81.20 JHF 14 sd_wan blocks are documented below.
    Status string
    Computed field, returned in the response.
    UsePeerAsDefaultGateway bool
    Enable to make the ISP server the Default Gateway for the Gaia.
    UsePeerDns bool
    Enable to allow the ISP to define the IPv4 DNS server for the Gaia.
    Username string
    The username needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP
    ClientId float64
    The PPPoE client Id. This ID must be unique for every PPPoE interface.
    Comments string
    User comments.
    Debug bool
    Enable debug logging for this resource.
    Enabled bool
    Enable to turn on the interface.
    FakePeerSettings GaiaPppoeInterfaceFakePeerSettingsArgs
    Fake peer settings fake_peer_settings blocks are documented below.
    GaiaPppoeInterfaceId string
    Interface string
    The name of the applicable physical interface. Gaia uses this interface to forward PPPoE frames.
    MemberId string
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    Name string
    The PPPoE interface name.
    Password string
    The password needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP
    PasswordHash string
    The hash of the password needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP.
    SdWan GaiaPppoeInterfaceSdWanArgs
    SD-WAN configuration. Supported starting from R81.20 JHF 14 sd_wan blocks are documented below.
    Status string
    Computed field, returned in the response.
    UsePeerAsDefaultGateway bool
    Enable to make the ISP server the Default Gateway for the Gaia.
    UsePeerDns bool
    Enable to allow the ISP to define the IPv4 DNS server for the Gaia.
    Username string
    The username needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP
    client_id number
    The PPPoE client Id. This ID must be unique for every PPPoE interface.
    comments string
    User comments.
    debug bool
    Enable debug logging for this resource.
    enabled bool
    Enable to turn on the interface.
    fake_peer_settings object
    Fake peer settings fake_peer_settings blocks are documented below.
    gaia_pppoe_interface_id string
    interface string
    The name of the applicable physical interface. Gaia uses this interface to forward PPPoE frames.
    member_id string
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    name string
    The PPPoE interface name.
    password string
    The password needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP
    password_hash string
    The hash of the password needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP.
    sd_wan object
    SD-WAN configuration. Supported starting from R81.20 JHF 14 sd_wan blocks are documented below.
    status string
    Computed field, returned in the response.
    use_peer_as_default_gateway bool
    Enable to make the ISP server the Default Gateway for the Gaia.
    use_peer_dns bool
    Enable to allow the ISP to define the IPv4 DNS server for the Gaia.
    username string
    The username needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP
    clientId Double
    The PPPoE client Id. This ID must be unique for every PPPoE interface.
    comments String
    User comments.
    debug Boolean
    Enable debug logging for this resource.
    enabled Boolean
    Enable to turn on the interface.
    fakePeerSettings GaiaPppoeInterfaceFakePeerSettings
    Fake peer settings fake_peer_settings blocks are documented below.
    gaiaPppoeInterfaceId String
    interface_ String
    The name of the applicable physical interface. Gaia uses this interface to forward PPPoE frames.
    memberId String
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    name String
    The PPPoE interface name.
    password String
    The password needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP
    passwordHash String
    The hash of the password needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP.
    sdWan GaiaPppoeInterfaceSdWan
    SD-WAN configuration. Supported starting from R81.20 JHF 14 sd_wan blocks are documented below.
    status String
    Computed field, returned in the response.
    usePeerAsDefaultGateway Boolean
    Enable to make the ISP server the Default Gateway for the Gaia.
    usePeerDns Boolean
    Enable to allow the ISP to define the IPv4 DNS server for the Gaia.
    username String
    The username needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP
    clientId number
    The PPPoE client Id. This ID must be unique for every PPPoE interface.
    comments string
    User comments.
    debug boolean
    Enable debug logging for this resource.
    enabled boolean
    Enable to turn on the interface.
    fakePeerSettings GaiaPppoeInterfaceFakePeerSettings
    Fake peer settings fake_peer_settings blocks are documented below.
    gaiaPppoeInterfaceId string
    interface string
    The name of the applicable physical interface. Gaia uses this interface to forward PPPoE frames.
    memberId string
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    name string
    The PPPoE interface name.
    password string
    The password needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP
    passwordHash string
    The hash of the password needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP.
    sdWan GaiaPppoeInterfaceSdWan
    SD-WAN configuration. Supported starting from R81.20 JHF 14 sd_wan blocks are documented below.
    status string
    Computed field, returned in the response.
    usePeerAsDefaultGateway boolean
    Enable to make the ISP server the Default Gateway for the Gaia.
    usePeerDns boolean
    Enable to allow the ISP to define the IPv4 DNS server for the Gaia.
    username string
    The username needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP
    client_id float
    The PPPoE client Id. This ID must be unique for every PPPoE interface.
    comments str
    User comments.
    debug bool
    Enable debug logging for this resource.
    enabled bool
    Enable to turn on the interface.
    fake_peer_settings GaiaPppoeInterfaceFakePeerSettingsArgs
    Fake peer settings fake_peer_settings blocks are documented below.
    gaia_pppoe_interface_id str
    interface str
    The name of the applicable physical interface. Gaia uses this interface to forward PPPoE frames.
    member_id str
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    name str
    The PPPoE interface name.
    password str
    The password needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP
    password_hash str
    The hash of the password needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP.
    sd_wan GaiaPppoeInterfaceSdWanArgs
    SD-WAN configuration. Supported starting from R81.20 JHF 14 sd_wan blocks are documented below.
    status str
    Computed field, returned in the response.
    use_peer_as_default_gateway bool
    Enable to make the ISP server the Default Gateway for the Gaia.
    use_peer_dns bool
    Enable to allow the ISP to define the IPv4 DNS server for the Gaia.
    username str
    The username needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP
    clientId Number
    The PPPoE client Id. This ID must be unique for every PPPoE interface.
    comments String
    User comments.
    debug Boolean
    Enable debug logging for this resource.
    enabled Boolean
    Enable to turn on the interface.
    fakePeerSettings Property Map
    Fake peer settings fake_peer_settings blocks are documented below.
    gaiaPppoeInterfaceId String
    interface String
    The name of the applicable physical interface. Gaia uses this interface to forward PPPoE frames.
    memberId String
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    name String
    The PPPoE interface name.
    password String
    The password needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP
    passwordHash String
    The hash of the password needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP.
    sdWan Property Map
    SD-WAN configuration. Supported starting from R81.20 JHF 14 sd_wan blocks are documented below.
    status String
    Computed field, returned in the response.
    usePeerAsDefaultGateway Boolean
    Enable to make the ISP server the Default Gateway for the Gaia.
    usePeerDns Boolean
    Enable to allow the ISP to define the IPv4 DNS server for the Gaia.
    username String
    The username needed to connect to the PPPoE server at the Internet Service Provider (ISP). Get it from the ISP

    Supporting Types

    GaiaPppoeInterfaceFakePeerSettings, GaiaPppoeInterfaceFakePeerSettingsArgs

    Address string
    The fake unicast peer IPv4 address (the default value is 0.0.0.0).
    Enabled bool
    Enable to use the configured fake peer IPv4 address.
    Address string
    The fake unicast peer IPv4 address (the default value is 0.0.0.0).
    Enabled bool
    Enable to use the configured fake peer IPv4 address.
    address string
    The fake unicast peer IPv4 address (the default value is 0.0.0.0).
    enabled bool
    Enable to use the configured fake peer IPv4 address.
    address String
    The fake unicast peer IPv4 address (the default value is 0.0.0.0).
    enabled Boolean
    Enable to use the configured fake peer IPv4 address.
    address string
    The fake unicast peer IPv4 address (the default value is 0.0.0.0).
    enabled boolean
    Enable to use the configured fake peer IPv4 address.
    address str
    The fake unicast peer IPv4 address (the default value is 0.0.0.0).
    enabled bool
    Enable to use the configured fake peer IPv4 address.
    address String
    The fake unicast peer IPv4 address (the default value is 0.0.0.0).
    enabled Boolean
    Enable to use the configured fake peer IPv4 address.

    GaiaPppoeInterfaceSdWan, GaiaPppoeInterfaceSdWanArgs

    Bandwidth GaiaPppoeInterfaceSdWanBandwidth
    Optional Bandwidth configuration. Bandwidth configuration is supported starting from R81.20 JHF 79 bandwidth blocks are documented below.
    CircuitId string
    Optional override interface circuit id value. Circuit-ID configuration is supported starting from R81.20 JHF 79
    Enabled bool
    Enable SD-WAN on this interface.
    Nat GaiaPppoeInterfaceSdWanNat
    Optional NAT configuration nat blocks are documented below.
    NextHop string
    Configure interface's next hop IPv4 address, obtain next hop IPv4 address automatically or set as a layer 2-only link
    NextHopIpv6 string
    Configure interface's next hop IPv6 address or obtain next hop IPv6 address automatically. IPv6 configuration is supported starting from R82 latest Jumbo Hotfix
    Tag string
    Optional tag configuration. Must contain only alphanumeric characters, '-' or '_' (max length is 64)
    Bandwidth GaiaPppoeInterfaceSdWanBandwidth
    Optional Bandwidth configuration. Bandwidth configuration is supported starting from R81.20 JHF 79 bandwidth blocks are documented below.
    CircuitId string
    Optional override interface circuit id value. Circuit-ID configuration is supported starting from R81.20 JHF 79
    Enabled bool
    Enable SD-WAN on this interface.
    Nat GaiaPppoeInterfaceSdWanNat
    Optional NAT configuration nat blocks are documented below.
    NextHop string
    Configure interface's next hop IPv4 address, obtain next hop IPv4 address automatically or set as a layer 2-only link
    NextHopIpv6 string
    Configure interface's next hop IPv6 address or obtain next hop IPv6 address automatically. IPv6 configuration is supported starting from R82 latest Jumbo Hotfix
    Tag string
    Optional tag configuration. Must contain only alphanumeric characters, '-' or '_' (max length is 64)
    bandwidth object
    Optional Bandwidth configuration. Bandwidth configuration is supported starting from R81.20 JHF 79 bandwidth blocks are documented below.
    circuit_id string
    Optional override interface circuit id value. Circuit-ID configuration is supported starting from R81.20 JHF 79
    enabled bool
    Enable SD-WAN on this interface.
    nat object
    Optional NAT configuration nat blocks are documented below.
    next_hop string
    Configure interface's next hop IPv4 address, obtain next hop IPv4 address automatically or set as a layer 2-only link
    next_hop_ipv6 string
    Configure interface's next hop IPv6 address or obtain next hop IPv6 address automatically. IPv6 configuration is supported starting from R82 latest Jumbo Hotfix
    tag string
    Optional tag configuration. Must contain only alphanumeric characters, '-' or '_' (max length is 64)
    bandwidth GaiaPppoeInterfaceSdWanBandwidth
    Optional Bandwidth configuration. Bandwidth configuration is supported starting from R81.20 JHF 79 bandwidth blocks are documented below.
    circuitId String
    Optional override interface circuit id value. Circuit-ID configuration is supported starting from R81.20 JHF 79
    enabled Boolean
    Enable SD-WAN on this interface.
    nat GaiaPppoeInterfaceSdWanNat
    Optional NAT configuration nat blocks are documented below.
    nextHop String
    Configure interface's next hop IPv4 address, obtain next hop IPv4 address automatically or set as a layer 2-only link
    nextHopIpv6 String
    Configure interface's next hop IPv6 address or obtain next hop IPv6 address automatically. IPv6 configuration is supported starting from R82 latest Jumbo Hotfix
    tag String
    Optional tag configuration. Must contain only alphanumeric characters, '-' or '_' (max length is 64)
    bandwidth GaiaPppoeInterfaceSdWanBandwidth
    Optional Bandwidth configuration. Bandwidth configuration is supported starting from R81.20 JHF 79 bandwidth blocks are documented below.
    circuitId string
    Optional override interface circuit id value. Circuit-ID configuration is supported starting from R81.20 JHF 79
    enabled boolean
    Enable SD-WAN on this interface.
    nat GaiaPppoeInterfaceSdWanNat
    Optional NAT configuration nat blocks are documented below.
    nextHop string
    Configure interface's next hop IPv4 address, obtain next hop IPv4 address automatically or set as a layer 2-only link
    nextHopIpv6 string
    Configure interface's next hop IPv6 address or obtain next hop IPv6 address automatically. IPv6 configuration is supported starting from R82 latest Jumbo Hotfix
    tag string
    Optional tag configuration. Must contain only alphanumeric characters, '-' or '_' (max length is 64)
    bandwidth GaiaPppoeInterfaceSdWanBandwidth
    Optional Bandwidth configuration. Bandwidth configuration is supported starting from R81.20 JHF 79 bandwidth blocks are documented below.
    circuit_id str
    Optional override interface circuit id value. Circuit-ID configuration is supported starting from R81.20 JHF 79
    enabled bool
    Enable SD-WAN on this interface.
    nat GaiaPppoeInterfaceSdWanNat
    Optional NAT configuration nat blocks are documented below.
    next_hop str
    Configure interface's next hop IPv4 address, obtain next hop IPv4 address automatically or set as a layer 2-only link
    next_hop_ipv6 str
    Configure interface's next hop IPv6 address or obtain next hop IPv6 address automatically. IPv6 configuration is supported starting from R82 latest Jumbo Hotfix
    tag str
    Optional tag configuration. Must contain only alphanumeric characters, '-' or '_' (max length is 64)
    bandwidth Property Map
    Optional Bandwidth configuration. Bandwidth configuration is supported starting from R81.20 JHF 79 bandwidth blocks are documented below.
    circuitId String
    Optional override interface circuit id value. Circuit-ID configuration is supported starting from R81.20 JHF 79
    enabled Boolean
    Enable SD-WAN on this interface.
    nat Property Map
    Optional NAT configuration nat blocks are documented below.
    nextHop String
    Configure interface's next hop IPv4 address, obtain next hop IPv4 address automatically or set as a layer 2-only link
    nextHopIpv6 String
    Configure interface's next hop IPv6 address or obtain next hop IPv6 address automatically. IPv6 configuration is supported starting from R82 latest Jumbo Hotfix
    tag String
    Optional tag configuration. Must contain only alphanumeric characters, '-' or '_' (max length is 64)

    GaiaPppoeInterfaceSdWanBandwidth, GaiaPppoeInterfaceSdWanBandwidthArgs

    DownloadSpeed string
    In Mbps
    UploadSpeed string
    In Mbps
    DownloadSpeed string
    In Mbps
    UploadSpeed string
    In Mbps
    download_speed string
    In Mbps
    upload_speed string
    In Mbps
    downloadSpeed String
    In Mbps
    uploadSpeed String
    In Mbps
    downloadSpeed string
    In Mbps
    uploadSpeed string
    In Mbps
    download_speed str
    In Mbps
    upload_speed str
    In Mbps
    downloadSpeed String
    In Mbps
    uploadSpeed String
    In Mbps

    GaiaPppoeInterfaceSdWanNat, GaiaPppoeInterfaceSdWanNatArgs

    Enabled bool
    Enable NAT IP address on this interface
    Ip string
    Configure NAT IPv4 address on this interface or obtain NAT IPv4 address automatically.
    Ipv6 string
    Configure NAT IPv6 address on this interface or obtain NAT IPv6 address automatically. IPv6 configuration is supported starting from R82 latest Jumbo Hotfix
    Enabled bool
    Enable NAT IP address on this interface
    Ip string
    Configure NAT IPv4 address on this interface or obtain NAT IPv4 address automatically.
    Ipv6 string
    Configure NAT IPv6 address on this interface or obtain NAT IPv6 address automatically. IPv6 configuration is supported starting from R82 latest Jumbo Hotfix
    enabled bool
    Enable NAT IP address on this interface
    ip string
    Configure NAT IPv4 address on this interface or obtain NAT IPv4 address automatically.
    ipv6 string
    Configure NAT IPv6 address on this interface or obtain NAT IPv6 address automatically. IPv6 configuration is supported starting from R82 latest Jumbo Hotfix
    enabled Boolean
    Enable NAT IP address on this interface
    ip String
    Configure NAT IPv4 address on this interface or obtain NAT IPv4 address automatically.
    ipv6 String
    Configure NAT IPv6 address on this interface or obtain NAT IPv6 address automatically. IPv6 configuration is supported starting from R82 latest Jumbo Hotfix
    enabled boolean
    Enable NAT IP address on this interface
    ip string
    Configure NAT IPv4 address on this interface or obtain NAT IPv4 address automatically.
    ipv6 string
    Configure NAT IPv6 address on this interface or obtain NAT IPv6 address automatically. IPv6 configuration is supported starting from R82 latest Jumbo Hotfix
    enabled bool
    Enable NAT IP address on this interface
    ip str
    Configure NAT IPv4 address on this interface or obtain NAT IPv4 address automatically.
    ipv6 str
    Configure NAT IPv6 address on this interface or obtain NAT IPv6 address automatically. IPv6 configuration is supported starting from R82 latest Jumbo Hotfix
    enabled Boolean
    Enable NAT IP address on this interface
    ip String
    Configure NAT IPv4 address on this interface or obtain NAT IPv4 address automatically.
    ipv6 String
    Configure NAT IPv6 address on this interface or obtain NAT IPv6 address automatically. IPv6 configuration is supported starting from R82 latest Jumbo Hotfix

    Package Details

    Repository
    checkpoint checkpointsw/terraform-provider-checkpoint
    License
    Notes
    This Pulumi package is based on the checkpoint Terraform Provider.
    Viewing docs for checkpoint 3.2.0
    published on Monday, Jun 15, 2026 by checkpointsw
    Schema (JSON)
    checkpointsw/terraform-provider-checkpoint

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial