published on Monday, Jun 15, 2026 by checkpointsw
published on Monday, Jun 15, 2026 by checkpointsw
This resource allows you to execute Check Point Pim Interface.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as checkpoint from "@pulumi/checkpoint";
// Step 1: configure PIM mode
const pimSetup = new checkpoint.GaiaCommandSetPim("pim_setup", {mode: "sparse"});
// Step 2: add the PIM interface
const example = new checkpoint.GaiaPimInterface("example", {
name: "eth0",
drPriority: "12",
enableVirtualAddress: false,
}, {
dependsOn: [pimSetup],
});
import pulumi
import pulumi_checkpoint as checkpoint
# Step 1: configure PIM mode
pim_setup = checkpoint.GaiaCommandSetPim("pim_setup", mode="sparse")
# Step 2: add the PIM interface
example = checkpoint.GaiaPimInterface("example",
name="eth0",
dr_priority="12",
enable_virtual_address=False,
opts = pulumi.ResourceOptions(depends_on=[pim_setup]))
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 {
// Step 1: configure PIM mode
pimSetup, err := checkpoint.NewGaiaCommandSetPim(ctx, "pim_setup", &checkpoint.GaiaCommandSetPimArgs{
Mode: pulumi.String("sparse"),
})
if err != nil {
return err
}
// Step 2: add the PIM interface
_, err = checkpoint.NewGaiaPimInterface(ctx, "example", &checkpoint.GaiaPimInterfaceArgs{
Name: pulumi.String("eth0"),
DrPriority: pulumi.String("12"),
EnableVirtualAddress: pulumi.Bool(false),
}, pulumi.DependsOn([]pulumi.Resource{
pimSetup,
}))
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Checkpoint = Pulumi.Checkpoint;
return await Deployment.RunAsync(() =>
{
// Step 1: configure PIM mode
var pimSetup = new Checkpoint.GaiaCommandSetPim("pim_setup", new()
{
Mode = "sparse",
});
// Step 2: add the PIM interface
var example = new Checkpoint.GaiaPimInterface("example", new()
{
Name = "eth0",
DrPriority = "12",
EnableVirtualAddress = false,
}, new CustomResourceOptions
{
DependsOn =
{
pimSetup,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.checkpoint.GaiaCommandSetPim;
import com.pulumi.checkpoint.GaiaCommandSetPimArgs;
import com.pulumi.checkpoint.GaiaPimInterface;
import com.pulumi.checkpoint.GaiaPimInterfaceArgs;
import com.pulumi.resources.CustomResourceOptions;
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) {
// Step 1: configure PIM mode
var pimSetup = new GaiaCommandSetPim("pimSetup", GaiaCommandSetPimArgs.builder()
.mode("sparse")
.build());
// Step 2: add the PIM interface
var example = new GaiaPimInterface("example", GaiaPimInterfaceArgs.builder()
.name("eth0")
.drPriority("12")
.enableVirtualAddress(false)
.build(), CustomResourceOptions.builder()
.dependsOn(pimSetup)
.build());
}
}
resources:
# Step 1: configure PIM mode
pimSetup:
type: checkpoint:GaiaCommandSetPim
name: pim_setup
properties:
mode: sparse
# Step 2: add the PIM interface
example:
type: checkpoint:GaiaPimInterface
properties:
name: eth0
drPriority: '12'
enableVirtualAddress: false
options:
dependsOn:
- ${pimSetup}
Example coming soon!
Create GaiaPimInterface Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GaiaPimInterface(name: string, args?: GaiaPimInterfaceArgs, opts?: CustomResourceOptions);@overload
def GaiaPimInterface(resource_name: str,
args: Optional[GaiaPimInterfaceArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def GaiaPimInterface(resource_name: str,
opts: Optional[ResourceOptions] = None,
debug: Optional[bool] = None,
dr_priority: Optional[str] = None,
enable_virtual_address: Optional[bool] = None,
gaia_pim_interface_id: Optional[str] = None,
ip_reachability_detection: Optional[bool] = None,
member_id: Optional[str] = None,
name: Optional[str] = None,
neighbor_filters: Optional[Sequence[GaiaPimInterfaceNeighborFilterArgs]] = None)func NewGaiaPimInterface(ctx *Context, name string, args *GaiaPimInterfaceArgs, opts ...ResourceOption) (*GaiaPimInterface, error)public GaiaPimInterface(string name, GaiaPimInterfaceArgs? args = null, CustomResourceOptions? opts = null)
public GaiaPimInterface(String name, GaiaPimInterfaceArgs args)
public GaiaPimInterface(String name, GaiaPimInterfaceArgs args, CustomResourceOptions options)
type: checkpoint:GaiaPimInterface
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "checkpoint_gaiapiminterface" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args GaiaPimInterfaceArgs
- 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 GaiaPimInterfaceArgs
- 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 GaiaPimInterfaceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GaiaPimInterfaceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GaiaPimInterfaceArgs
- 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 gaiaPimInterfaceResource = new Checkpoint.GaiaPimInterface("gaiaPimInterfaceResource", new()
{
Debug = false,
DrPriority = "string",
EnableVirtualAddress = false,
GaiaPimInterfaceId = "string",
IpReachabilityDetection = false,
MemberId = "string",
Name = "string",
NeighborFilters = new[]
{
new Checkpoint.Inputs.GaiaPimInterfaceNeighborFilterArgs
{
Address = "string",
},
},
});
example, err := checkpoint.NewGaiaPimInterface(ctx, "gaiaPimInterfaceResource", &checkpoint.GaiaPimInterfaceArgs{
Debug: pulumi.Bool(false),
DrPriority: pulumi.String("string"),
EnableVirtualAddress: pulumi.Bool(false),
GaiaPimInterfaceId: pulumi.String("string"),
IpReachabilityDetection: pulumi.Bool(false),
MemberId: pulumi.String("string"),
Name: pulumi.String("string"),
NeighborFilters: checkpoint.GaiaPimInterfaceNeighborFilterArray{
&checkpoint.GaiaPimInterfaceNeighborFilterArgs{
Address: pulumi.String("string"),
},
},
})
resource "checkpoint_gaiapiminterface" "gaiaPimInterfaceResource" {
debug = false
dr_priority = "string"
enable_virtual_address = false
gaia_pim_interface_id = "string"
ip_reachability_detection = false
member_id = "string"
name = "string"
neighbor_filters {
address = "string"
}
}
var gaiaPimInterfaceResource = new GaiaPimInterface("gaiaPimInterfaceResource", GaiaPimInterfaceArgs.builder()
.debug(false)
.drPriority("string")
.enableVirtualAddress(false)
.gaiaPimInterfaceId("string")
.ipReachabilityDetection(false)
.memberId("string")
.name("string")
.neighborFilters(GaiaPimInterfaceNeighborFilterArgs.builder()
.address("string")
.build())
.build());
gaia_pim_interface_resource = checkpoint.GaiaPimInterface("gaiaPimInterfaceResource",
debug=False,
dr_priority="string",
enable_virtual_address=False,
gaia_pim_interface_id="string",
ip_reachability_detection=False,
member_id="string",
name="string",
neighbor_filters=[{
"address": "string",
}])
const gaiaPimInterfaceResource = new checkpoint.GaiaPimInterface("gaiaPimInterfaceResource", {
debug: false,
drPriority: "string",
enableVirtualAddress: false,
gaiaPimInterfaceId: "string",
ipReachabilityDetection: false,
memberId: "string",
name: "string",
neighborFilters: [{
address: "string",
}],
});
type: checkpoint:GaiaPimInterface
properties:
debug: false
drPriority: string
enableVirtualAddress: false
gaiaPimInterfaceId: string
ipReachabilityDetection: false
memberId: string
name: string
neighborFilters:
- address: string
GaiaPimInterface 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 GaiaPimInterface resource accepts the following input properties:
- Debug bool
- Enable debug logging for this resource.
- Dr
Priority string - Used to determine the relative preference when electing a Designated Router (DR).
- Enable
Virtual boolAddress - Configures VRRP mode for the given interface.
- Gaia
Pim stringInterface Id - Ip
Reachability boolDetection - Configure BFD IP-Reachability Detection
- 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 interface name.
- Neighbor
Filters List<GaiaPim Interface Neighbor Filter> - Configure Neighbor Filter neighbor_filter blocks are documented below.
- Debug bool
- Enable debug logging for this resource.
- Dr
Priority string - Used to determine the relative preference when electing a Designated Router (DR).
- Enable
Virtual boolAddress - Configures VRRP mode for the given interface.
- Gaia
Pim stringInterface Id - Ip
Reachability boolDetection - Configure BFD IP-Reachability Detection
- 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 interface name.
- Neighbor
Filters []GaiaPim Interface Neighbor Filter Args - Configure Neighbor Filter neighbor_filter blocks are documented below.
- debug bool
- Enable debug logging for this resource.
- dr_
priority string - Used to determine the relative preference when electing a Designated Router (DR).
- enable_
virtual_ booladdress - Configures VRRP mode for the given interface.
- gaia_
pim_ stringinterface_ id - ip_
reachability_ booldetection - Configure BFD IP-Reachability Detection
- 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 interface name.
- neighbor_
filters list(object) - Configure Neighbor Filter neighbor_filter blocks are documented below.
- debug Boolean
- Enable debug logging for this resource.
- dr
Priority String - Used to determine the relative preference when electing a Designated Router (DR).
- enable
Virtual BooleanAddress - Configures VRRP mode for the given interface.
- gaia
Pim StringInterface Id - ip
Reachability BooleanDetection - Configure BFD IP-Reachability Detection
- 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 interface name.
- neighbor
Filters List<GaiaPim Interface Neighbor Filter> - Configure Neighbor Filter neighbor_filter blocks are documented below.
- debug boolean
- Enable debug logging for this resource.
- dr
Priority string - Used to determine the relative preference when electing a Designated Router (DR).
- enable
Virtual booleanAddress - Configures VRRP mode for the given interface.
- gaia
Pim stringInterface Id - ip
Reachability booleanDetection - Configure BFD IP-Reachability Detection
- 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 interface name.
- neighbor
Filters GaiaPim Interface Neighbor Filter[] - Configure Neighbor Filter neighbor_filter blocks are documented below.
- debug bool
- Enable debug logging for this resource.
- dr_
priority str - Used to determine the relative preference when electing a Designated Router (DR).
- enable_
virtual_ booladdress - Configures VRRP mode for the given interface.
- gaia_
pim_ strinterface_ id - ip_
reachability_ booldetection - Configure BFD IP-Reachability Detection
- 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 interface name.
- neighbor_
filters Sequence[GaiaPim Interface Neighbor Filter Args] - Configure Neighbor Filter neighbor_filter blocks are documented below.
- debug Boolean
- Enable debug logging for this resource.
- dr
Priority String - Used to determine the relative preference when electing a Designated Router (DR).
- enable
Virtual BooleanAddress - Configures VRRP mode for the given interface.
- gaia
Pim StringInterface Id - ip
Reachability BooleanDetection - Configure BFD IP-Reachability Detection
- 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 interface name.
- neighbor
Filters List<Property Map> - Configure Neighbor Filter neighbor_filter blocks are documented below.
Outputs
All input properties are implicitly available as output properties. Additionally, the GaiaPimInterface resource produces the following output properties:
- dr_
address string - id string
- The provider-assigned unique ID for this managed resource.
- mode string
- neighbor_
amount number - state string
- status string
- dr_
address str - id str
- The provider-assigned unique ID for this managed resource.
- mode str
- neighbor_
amount float - state str
- status str
Look up Existing GaiaPimInterface Resource
Get an existing GaiaPimInterface 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?: GaiaPimInterfaceState, opts?: CustomResourceOptions): GaiaPimInterface@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
debug: Optional[bool] = None,
dr_address: Optional[str] = None,
dr_priority: Optional[str] = None,
enable_virtual_address: Optional[bool] = None,
gaia_pim_interface_id: Optional[str] = None,
ip_reachability_detection: Optional[bool] = None,
member_id: Optional[str] = None,
mode: Optional[str] = None,
name: Optional[str] = None,
neighbor_amount: Optional[float] = None,
neighbor_filters: Optional[Sequence[GaiaPimInterfaceNeighborFilterArgs]] = None,
state: Optional[str] = None,
status: Optional[str] = None) -> GaiaPimInterfacefunc GetGaiaPimInterface(ctx *Context, name string, id IDInput, state *GaiaPimInterfaceState, opts ...ResourceOption) (*GaiaPimInterface, error)public static GaiaPimInterface Get(string name, Input<string> id, GaiaPimInterfaceState? state, CustomResourceOptions? opts = null)public static GaiaPimInterface get(String name, Output<String> id, GaiaPimInterfaceState state, CustomResourceOptions options)resources: _: type: checkpoint:GaiaPimInterface get: id: ${id}import {
to = checkpoint_gaiapiminterface.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.
- Debug bool
- Enable debug logging for this resource.
- Dr
Address string - Dr
Priority string - Used to determine the relative preference when electing a Designated Router (DR).
- Enable
Virtual boolAddress - Configures VRRP mode for the given interface.
- Gaia
Pim stringInterface Id - Ip
Reachability boolDetection - Configure BFD IP-Reachability Detection
- 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
- Mode string
- Name string
- The interface name.
- Neighbor
Amount double - Neighbor
Filters List<GaiaPim Interface Neighbor Filter> - Configure Neighbor Filter neighbor_filter blocks are documented below.
- State string
- Status string
- Debug bool
- Enable debug logging for this resource.
- Dr
Address string - Dr
Priority string - Used to determine the relative preference when electing a Designated Router (DR).
- Enable
Virtual boolAddress - Configures VRRP mode for the given interface.
- Gaia
Pim stringInterface Id - Ip
Reachability boolDetection - Configure BFD IP-Reachability Detection
- 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
- Mode string
- Name string
- The interface name.
- Neighbor
Amount float64 - Neighbor
Filters []GaiaPim Interface Neighbor Filter Args - Configure Neighbor Filter neighbor_filter blocks are documented below.
- State string
- Status string
- debug bool
- Enable debug logging for this resource.
- dr_
address string - dr_
priority string - Used to determine the relative preference when electing a Designated Router (DR).
- enable_
virtual_ booladdress - Configures VRRP mode for the given interface.
- gaia_
pim_ stringinterface_ id - ip_
reachability_ booldetection - Configure BFD IP-Reachability Detection
- 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
- mode string
- name string
- The interface name.
- neighbor_
amount number - neighbor_
filters list(object) - Configure Neighbor Filter neighbor_filter blocks are documented below.
- state string
- status string
- debug Boolean
- Enable debug logging for this resource.
- dr
Address String - dr
Priority String - Used to determine the relative preference when electing a Designated Router (DR).
- enable
Virtual BooleanAddress - Configures VRRP mode for the given interface.
- gaia
Pim StringInterface Id - ip
Reachability BooleanDetection - Configure BFD IP-Reachability Detection
- 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
- mode String
- name String
- The interface name.
- neighbor
Amount Double - neighbor
Filters List<GaiaPim Interface Neighbor Filter> - Configure Neighbor Filter neighbor_filter blocks are documented below.
- state String
- status String
- debug boolean
- Enable debug logging for this resource.
- dr
Address string - dr
Priority string - Used to determine the relative preference when electing a Designated Router (DR).
- enable
Virtual booleanAddress - Configures VRRP mode for the given interface.
- gaia
Pim stringInterface Id - ip
Reachability booleanDetection - Configure BFD IP-Reachability Detection
- 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
- mode string
- name string
- The interface name.
- neighbor
Amount number - neighbor
Filters GaiaPim Interface Neighbor Filter[] - Configure Neighbor Filter neighbor_filter blocks are documented below.
- state string
- status string
- debug bool
- Enable debug logging for this resource.
- dr_
address str - dr_
priority str - Used to determine the relative preference when electing a Designated Router (DR).
- enable_
virtual_ booladdress - Configures VRRP mode for the given interface.
- gaia_
pim_ strinterface_ id - ip_
reachability_ booldetection - Configure BFD IP-Reachability Detection
- 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
- mode str
- name str
- The interface name.
- neighbor_
amount float - neighbor_
filters Sequence[GaiaPim Interface Neighbor Filter Args] - Configure Neighbor Filter neighbor_filter blocks are documented below.
- state str
- status str
- debug Boolean
- Enable debug logging for this resource.
- dr
Address String - dr
Priority String - Used to determine the relative preference when electing a Designated Router (DR).
- enable
Virtual BooleanAddress - Configures VRRP mode for the given interface.
- gaia
Pim StringInterface Id - ip
Reachability BooleanDetection - Configure BFD IP-Reachability Detection
- 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
- mode String
- name String
- The interface name.
- neighbor
Amount Number - neighbor
Filters List<Property Map> - Configure Neighbor Filter neighbor_filter blocks are documented below.
- state String
- status String
Supporting Types
GaiaPimInterfaceNeighborFilter, GaiaPimInterfaceNeighborFilterArgs
- Address string
- The multicast group prefix/mask, in CIDR notation.
- Address string
- The multicast group prefix/mask, in CIDR notation.
- address string
- The multicast group prefix/mask, in CIDR notation.
- address String
- The multicast group prefix/mask, in CIDR notation.
- address string
- The multicast group prefix/mask, in CIDR notation.
- address str
- The multicast group prefix/mask, in CIDR notation.
- address String
- The multicast group prefix/mask, in CIDR notation.
Package Details
- Repository
- checkpoint checkpointsw/terraform-provider-checkpoint
- License
- Notes
- This Pulumi package is based on the
checkpointTerraform Provider.
published on Monday, Jun 15, 2026 by checkpointsw