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

checkpoint.GaiaVirtualGateway

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 Virtual Gateway.

    Example Usage

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

const example = new checkpoint.GaiaVirtualGateway("example", {resourceId: 1});

    import pulumi
import pulumi_checkpoint as checkpoint

example = checkpoint.GaiaVirtualGateway("example", resource_id=1)

    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.NewGaiaVirtualGateway(ctx, "example", &checkpoint.GaiaVirtualGatewayArgs{
			ResourceId: pulumi.Float64(1),
		})
		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.GaiaVirtualGateway("example", new()
    {
        ResourceId = 1,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.checkpoint.GaiaVirtualGateway;
import com.pulumi.checkpoint.GaiaVirtualGatewayArgs;
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 GaiaVirtualGateway("example", GaiaVirtualGatewayArgs.builder()
            .resourceId(1.0)
            .build());

    }
}

    resources:
  example:
    type: checkpoint:GaiaVirtualGateway
    properties:
      resourceId: 1

    Example coming soon!

    Create GaiaVirtualGateway Resource

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

    Constructor syntax

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

@overload
def GaiaVirtualGateway(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       resource_id: Optional[float] = None,
                       debug: Optional[bool] = None,
                       gaia_virtual_gateway_id: Optional[str] = None,
                       interfaces: Optional[Sequence[str]] = None,
                       member_id: Optional[str] = None,
                       mgmt_connection: Optional[GaiaVirtualGatewayMgmtConnectionArgs] = None,
                       one_time_password: Optional[str] = None,
                       resources: Optional[GaiaVirtualGatewayResourcesArgs] = None,
                       set_if_exist: Optional[bool] = None,
                       virtual_switches: Optional[Sequence[float]] = None)
    func NewGaiaVirtualGateway(ctx *Context, name string, args GaiaVirtualGatewayArgs, opts ...ResourceOption) (*GaiaVirtualGateway, error)
    public GaiaVirtualGateway(string name, GaiaVirtualGatewayArgs args, CustomResourceOptions? opts = null)
    public GaiaVirtualGateway(String name, GaiaVirtualGatewayArgs args)
public GaiaVirtualGateway(String name, GaiaVirtualGatewayArgs args, CustomResourceOptions options)

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


    resource "checkpoint_gaiavirtualgateway" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args GaiaVirtualGatewayArgs
    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 GaiaVirtualGatewayArgs
    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 GaiaVirtualGatewayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GaiaVirtualGatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GaiaVirtualGatewayArgs
    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 gaiaVirtualGatewayResource = new Checkpoint.GaiaVirtualGateway("gaiaVirtualGatewayResource", new()
{
    ResourceId = 0,
    Debug = false,
    GaiaVirtualGatewayId = "string",
    Interfaces = new[]
    {
        "string",
    },
    MemberId = "string",
    MgmtConnection = new Checkpoint.Inputs.GaiaVirtualGatewayMgmtConnectionArgs
    {
        MgmtConnectionIdentifier = "string",
        MgmtConnectionType = "string",
        MgmtIpv4Configuration = new Checkpoint.Inputs.GaiaVirtualGatewayMgmtConnectionMgmtIpv4ConfigurationArgs
        {
            Ipv4Address = "string",
            Ipv4DefaultGateway = "string",
            Ipv4Mask = 0,
        },
        MgmtIpv6Configuration = new Checkpoint.Inputs.GaiaVirtualGatewayMgmtConnectionMgmtIpv6ConfigurationArgs
        {
            Ipv6Address = "string",
            Ipv6DefaultGateway = "string",
            Ipv6Mask = 0,
        },
    },
    OneTimePassword = "string",
    Resources = new Checkpoint.Inputs.GaiaVirtualGatewayResourcesArgs
    {
        FirewallIpv4Instances = 0,
        FirewallIpv6Instances = 0,
    },
    SetIfExist = false,
    VirtualSwitches = new[]
    {
        0,
    },
});

    example, err := checkpoint.NewGaiaVirtualGateway(ctx, "gaiaVirtualGatewayResource", &checkpoint.GaiaVirtualGatewayArgs{
	ResourceId:           pulumi.Float64(0),
	Debug:                pulumi.Bool(false),
	GaiaVirtualGatewayId: pulumi.String("string"),
	Interfaces: pulumi.StringArray{
		pulumi.String("string"),
	},
	MemberId: pulumi.String("string"),
	MgmtConnection: &checkpoint.GaiaVirtualGatewayMgmtConnectionArgs{
		MgmtConnectionIdentifier: pulumi.String("string"),
		MgmtConnectionType:       pulumi.String("string"),
		MgmtIpv4Configuration: &checkpoint.GaiaVirtualGatewayMgmtConnectionMgmtIpv4ConfigurationArgs{
			Ipv4Address:        pulumi.String("string"),
			Ipv4DefaultGateway: pulumi.String("string"),
			Ipv4Mask:           pulumi.Float64(0),
		},
		MgmtIpv6Configuration: &checkpoint.GaiaVirtualGatewayMgmtConnectionMgmtIpv6ConfigurationArgs{
			Ipv6Address:        pulumi.String("string"),
			Ipv6DefaultGateway: pulumi.String("string"),
			Ipv6Mask:           pulumi.Float64(0),
		},
	},
	OneTimePassword: pulumi.String("string"),
	Resources: &checkpoint.GaiaVirtualGatewayResourcesArgs{
		FirewallIpv4Instances: pulumi.Float64(0),
		FirewallIpv6Instances: pulumi.Float64(0),
	},
	SetIfExist: pulumi.Bool(false),
	VirtualSwitches: pulumi.Float64Array{
		pulumi.Float64(0),
	},
})

    resource "checkpoint_gaiavirtualgateway" "gaiaVirtualGatewayResource" {
  resource_id             = 0
  debug                   = false
  gaia_virtual_gateway_id = "string"
  interfaces              = ["string"]
  member_id               = "string"
  mgmt_connection = {
    mgmt_connection_identifier = "string"
    mgmt_connection_type       = "string"
    mgmt_ipv4_configuration = {
      ipv4_address         = "string"
      ipv4_default_gateway = "string"
      ipv4_mask            = 0
    }
    mgmt_ipv6_configuration = {
      ipv6_address         = "string"
      ipv6_default_gateway = "string"
      ipv6_mask            = 0
    }
  }
  one_time_password = "string"
  resources = {
    firewall_ipv4_instances = 0
    firewall_ipv6_instances = 0
  }
  set_if_exist     = false
  virtual_switches = [0]
}

    var gaiaVirtualGatewayResource = new GaiaVirtualGateway("gaiaVirtualGatewayResource", GaiaVirtualGatewayArgs.builder()
    .resourceId(0.0)
    .debug(false)
    .gaiaVirtualGatewayId("string")
    .interfaces("string")
    .memberId("string")
    .mgmtConnection(GaiaVirtualGatewayMgmtConnectionArgs.builder()
        .mgmtConnectionIdentifier("string")
        .mgmtConnectionType("string")
        .mgmtIpv4Configuration(GaiaVirtualGatewayMgmtConnectionMgmtIpv4ConfigurationArgs.builder()
            .ipv4Address("string")
            .ipv4DefaultGateway("string")
            .ipv4Mask(0.0)
            .build())
        .mgmtIpv6Configuration(GaiaVirtualGatewayMgmtConnectionMgmtIpv6ConfigurationArgs.builder()
            .ipv6Address("string")
            .ipv6DefaultGateway("string")
            .ipv6Mask(0.0)
            .build())
        .build())
    .oneTimePassword("string")
    .resources(GaiaVirtualGatewayResourcesArgs.builder()
        .firewallIpv4Instances(0.0)
        .firewallIpv6Instances(0.0)
        .build())
    .setIfExist(false)
    .virtualSwitches(0.0)
    .build());

    gaia_virtual_gateway_resource = checkpoint.GaiaVirtualGateway("gaiaVirtualGatewayResource",
    resource_id=float(0),
    debug=False,
    gaia_virtual_gateway_id="string",
    interfaces=["string"],
    member_id="string",
    mgmt_connection={
        "mgmt_connection_identifier": "string",
        "mgmt_connection_type": "string",
        "mgmt_ipv4_configuration": {
            "ipv4_address": "string",
            "ipv4_default_gateway": "string",
            "ipv4_mask": float(0),
        },
        "mgmt_ipv6_configuration": {
            "ipv6_address": "string",
            "ipv6_default_gateway": "string",
            "ipv6_mask": float(0),
        },
    },
    one_time_password="string",
    resources={
        "firewall_ipv4_instances": float(0),
        "firewall_ipv6_instances": float(0),
    },
    set_if_exist=False,
    virtual_switches=[float(0)])

    const gaiaVirtualGatewayResource = new checkpoint.GaiaVirtualGateway("gaiaVirtualGatewayResource", {
    resourceId: 0,
    debug: false,
    gaiaVirtualGatewayId: "string",
    interfaces: ["string"],
    memberId: "string",
    mgmtConnection: {
        mgmtConnectionIdentifier: "string",
        mgmtConnectionType: "string",
        mgmtIpv4Configuration: {
            ipv4Address: "string",
            ipv4DefaultGateway: "string",
            ipv4Mask: 0,
        },
        mgmtIpv6Configuration: {
            ipv6Address: "string",
            ipv6DefaultGateway: "string",
            ipv6Mask: 0,
        },
    },
    oneTimePassword: "string",
    resources: {
        firewallIpv4Instances: 0,
        firewallIpv6Instances: 0,
    },
    setIfExist: false,
    virtualSwitches: [0],
});

    type: checkpoint:GaiaVirtualGateway
properties:
    debug: false
    gaiaVirtualGatewayId: string
    interfaces:
        - string
    memberId: string
    mgmtConnection:
        mgmtConnectionIdentifier: string
        mgmtConnectionType: string
        mgmtIpv4Configuration:
            ipv4Address: string
            ipv4DefaultGateway: string
            ipv4Mask: 0
        mgmtIpv6Configuration:
            ipv6Address: string
            ipv6DefaultGateway: string
            ipv6Mask: 0
    oneTimePassword: string
    resourceId: 0
    resources:
        firewallIpv4Instances: 0
        firewallIpv6Instances: 0
    setIfExist: false
    virtualSwitches:
        - 0

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

    ResourceId double
    Virtual gateway identifier can be an integer or the next avaliable id (auto)
    Debug bool
    Enable debug logging for this resource.
    GaiaVirtualGatewayId string
    Interfaces List<string>
    Network interface(s) to be attached interfaces blocks are documented below.
    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
    MgmtConnection GaiaVirtualGatewayMgmtConnection
    Management connection configurations mgmt_connection blocks are documented below.
    OneTimePassword string
    One time password, used for the secure internal communication with the Management object
    Resources GaiaVirtualGatewayResources
    Additional resources resources blocks are documented below.
    SetIfExist bool
    If another virtual gateway with the same identifier already exists, it will be updated. The command behaviour will be the same as if originally a set command was called. Pay attention that original virtual gateway's fields will be overwritten by the fields provided in the request payload!
    VirtualSwitches List<double>
    Virtual switche(s) to be connected, mgmt-switch (id 500) is set as default virtual_switches blocks are documented below.
    ResourceId float64
    Virtual gateway identifier can be an integer or the next avaliable id (auto)
    Debug bool
    Enable debug logging for this resource.
    GaiaVirtualGatewayId string
    Interfaces []string
    Network interface(s) to be attached interfaces blocks are documented below.
    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
    MgmtConnection GaiaVirtualGatewayMgmtConnectionArgs
    Management connection configurations mgmt_connection blocks are documented below.
    OneTimePassword string
    One time password, used for the secure internal communication with the Management object
    Resources GaiaVirtualGatewayResourcesArgs
    Additional resources resources blocks are documented below.
    SetIfExist bool
    If another virtual gateway with the same identifier already exists, it will be updated. The command behaviour will be the same as if originally a set command was called. Pay attention that original virtual gateway's fields will be overwritten by the fields provided in the request payload!
    VirtualSwitches []float64
    Virtual switche(s) to be connected, mgmt-switch (id 500) is set as default virtual_switches blocks are documented below.
    resource_id number
    Virtual gateway identifier can be an integer or the next avaliable id (auto)
    debug bool
    Enable debug logging for this resource.
    gaia_virtual_gateway_id string
    interfaces list(string)
    Network interface(s) to be attached interfaces blocks are documented below.
    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
    mgmt_connection object
    Management connection configurations mgmt_connection blocks are documented below.
    one_time_password string
    One time password, used for the secure internal communication with the Management object
    resources object
    Additional resources resources blocks are documented below.
    set_if_exist bool
    If another virtual gateway with the same identifier already exists, it will be updated. The command behaviour will be the same as if originally a set command was called. Pay attention that original virtual gateway's fields will be overwritten by the fields provided in the request payload!
    virtual_switches list(number)
    Virtual switche(s) to be connected, mgmt-switch (id 500) is set as default virtual_switches blocks are documented below.
    resourceId Double
    Virtual gateway identifier can be an integer or the next avaliable id (auto)
    debug Boolean
    Enable debug logging for this resource.
    gaiaVirtualGatewayId String
    interfaces List<String>
    Network interface(s) to be attached interfaces blocks are documented below.
    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
    mgmtConnection GaiaVirtualGatewayMgmtConnection
    Management connection configurations mgmt_connection blocks are documented below.
    oneTimePassword String
    One time password, used for the secure internal communication with the Management object
    resources GaiaVirtualGatewayResources
    Additional resources resources blocks are documented below.
    setIfExist Boolean
    If another virtual gateway with the same identifier already exists, it will be updated. The command behaviour will be the same as if originally a set command was called. Pay attention that original virtual gateway's fields will be overwritten by the fields provided in the request payload!
    virtualSwitches List<Double>
    Virtual switche(s) to be connected, mgmt-switch (id 500) is set as default virtual_switches blocks are documented below.
    resourceId number
    Virtual gateway identifier can be an integer or the next avaliable id (auto)
    debug boolean
    Enable debug logging for this resource.
    gaiaVirtualGatewayId string
    interfaces string[]
    Network interface(s) to be attached interfaces blocks are documented below.
    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
    mgmtConnection GaiaVirtualGatewayMgmtConnection
    Management connection configurations mgmt_connection blocks are documented below.
    oneTimePassword string
    One time password, used for the secure internal communication with the Management object
    resources GaiaVirtualGatewayResources
    Additional resources resources blocks are documented below.
    setIfExist boolean
    If another virtual gateway with the same identifier already exists, it will be updated. The command behaviour will be the same as if originally a set command was called. Pay attention that original virtual gateway's fields will be overwritten by the fields provided in the request payload!
    virtualSwitches number[]
    Virtual switche(s) to be connected, mgmt-switch (id 500) is set as default virtual_switches blocks are documented below.
    resource_id float
    Virtual gateway identifier can be an integer or the next avaliable id (auto)
    debug bool
    Enable debug logging for this resource.
    gaia_virtual_gateway_id str
    interfaces Sequence[str]
    Network interface(s) to be attached interfaces blocks are documented below.
    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
    mgmt_connection GaiaVirtualGatewayMgmtConnectionArgs
    Management connection configurations mgmt_connection blocks are documented below.
    one_time_password str
    One time password, used for the secure internal communication with the Management object
    resources GaiaVirtualGatewayResourcesArgs
    Additional resources resources blocks are documented below.
    set_if_exist bool
    If another virtual gateway with the same identifier already exists, it will be updated. The command behaviour will be the same as if originally a set command was called. Pay attention that original virtual gateway's fields will be overwritten by the fields provided in the request payload!
    virtual_switches Sequence[float]
    Virtual switche(s) to be connected, mgmt-switch (id 500) is set as default virtual_switches blocks are documented below.
    resourceId Number
    Virtual gateway identifier can be an integer or the next avaliable id (auto)
    debug Boolean
    Enable debug logging for this resource.
    gaiaVirtualGatewayId String
    interfaces List<String>
    Network interface(s) to be attached interfaces blocks are documented below.
    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
    mgmtConnection Property Map
    Management connection configurations mgmt_connection blocks are documented below.
    oneTimePassword String
    One time password, used for the secure internal communication with the Management object
    resources Property Map
    Additional resources resources blocks are documented below.
    setIfExist Boolean
    If another virtual gateway with the same identifier already exists, it will be updated. The command behaviour will be the same as if originally a set command was called. Pay attention that original virtual gateway's fields will be overwritten by the fields provided in the request payload!
    virtualSwitches List<Number>
    Virtual switche(s) to be connected, mgmt-switch (id 500) is set as default virtual_switches blocks are documented below.

    Outputs

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

    Action string
    Computed field, returned in the response.
    Id string
    The provider-assigned unique ID for this managed resource.
    Message string
    Computed field, returned in the response.
    Status string
    Computed field, returned in the response.
    VsId double
    Computed field, returned in the response.
    VsxdTaskId string
    Computed field, returned in the response.
    Action string
    Computed field, returned in the response.
    Id string
    The provider-assigned unique ID for this managed resource.
    Message string
    Computed field, returned in the response.
    Status string
    Computed field, returned in the response.
    VsId float64
    Computed field, returned in the response.
    VsxdTaskId string
    Computed field, returned in the response.
    action string
    Computed field, returned in the response.
    id string
    The provider-assigned unique ID for this managed resource.
    message string
    Computed field, returned in the response.
    status string
    Computed field, returned in the response.
    vs_id number
    Computed field, returned in the response.
    vsxd_task_id string
    Computed field, returned in the response.
    action String
    Computed field, returned in the response.
    id String
    The provider-assigned unique ID for this managed resource.
    message String
    Computed field, returned in the response.
    status String
    Computed field, returned in the response.
    vsId Double
    Computed field, returned in the response.
    vsxdTaskId String
    Computed field, returned in the response.
    action string
    Computed field, returned in the response.
    id string
    The provider-assigned unique ID for this managed resource.
    message string
    Computed field, returned in the response.
    status string
    Computed field, returned in the response.
    vsId number
    Computed field, returned in the response.
    vsxdTaskId string
    Computed field, returned in the response.
    action str
    Computed field, returned in the response.
    id str
    The provider-assigned unique ID for this managed resource.
    message str
    Computed field, returned in the response.
    status str
    Computed field, returned in the response.
    vs_id float
    Computed field, returned in the response.
    vsxd_task_id str
    Computed field, returned in the response.
    action String
    Computed field, returned in the response.
    id String
    The provider-assigned unique ID for this managed resource.
    message String
    Computed field, returned in the response.
    status String
    Computed field, returned in the response.
    vsId Number
    Computed field, returned in the response.
    vsxdTaskId String
    Computed field, returned in the response.

    Look up Existing GaiaVirtualGateway Resource

    Get an existing GaiaVirtualGateway 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?: GaiaVirtualGatewayState, opts?: CustomResourceOptions): GaiaVirtualGateway
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action: Optional[str] = None,
        debug: Optional[bool] = None,
        gaia_virtual_gateway_id: Optional[str] = None,
        interfaces: Optional[Sequence[str]] = None,
        member_id: Optional[str] = None,
        message: Optional[str] = None,
        mgmt_connection: Optional[GaiaVirtualGatewayMgmtConnectionArgs] = None,
        one_time_password: Optional[str] = None,
        resource_id: Optional[float] = None,
        resources: Optional[GaiaVirtualGatewayResourcesArgs] = None,
        set_if_exist: Optional[bool] = None,
        status: Optional[str] = None,
        virtual_switches: Optional[Sequence[float]] = None,
        vs_id: Optional[float] = None,
        vsxd_task_id: Optional[str] = None) -> GaiaVirtualGateway
    func GetGaiaVirtualGateway(ctx *Context, name string, id IDInput, state *GaiaVirtualGatewayState, opts ...ResourceOption) (*GaiaVirtualGateway, error)
    public static GaiaVirtualGateway Get(string name, Input<string> id, GaiaVirtualGatewayState? state, CustomResourceOptions? opts = null)
    public static GaiaVirtualGateway get(String name, Output<String> id, GaiaVirtualGatewayState state, CustomResourceOptions options)
    resources:  _:    type: checkpoint:GaiaVirtualGateway    get:      id: ${id}
    import {
  to = checkpoint_gaiavirtualgateway.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:
    Action string
    Computed field, returned in the response.
    Debug bool
    Enable debug logging for this resource.
    GaiaVirtualGatewayId string
    Interfaces List<string>
    Network interface(s) to be attached interfaces blocks are documented below.
    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
    Message string
    Computed field, returned in the response.
    MgmtConnection GaiaVirtualGatewayMgmtConnection
    Management connection configurations mgmt_connection blocks are documented below.
    OneTimePassword string
    One time password, used for the secure internal communication with the Management object
    ResourceId double
    Virtual gateway identifier can be an integer or the next avaliable id (auto)
    Resources GaiaVirtualGatewayResources
    Additional resources resources blocks are documented below.
    SetIfExist bool
    If another virtual gateway with the same identifier already exists, it will be updated. The command behaviour will be the same as if originally a set command was called. Pay attention that original virtual gateway's fields will be overwritten by the fields provided in the request payload!
    Status string
    Computed field, returned in the response.
    VirtualSwitches List<double>
    Virtual switche(s) to be connected, mgmt-switch (id 500) is set as default virtual_switches blocks are documented below.
    VsId double
    Computed field, returned in the response.
    VsxdTaskId string
    Computed field, returned in the response.
    Action string
    Computed field, returned in the response.
    Debug bool
    Enable debug logging for this resource.
    GaiaVirtualGatewayId string
    Interfaces []string
    Network interface(s) to be attached interfaces blocks are documented below.
    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
    Message string
    Computed field, returned in the response.
    MgmtConnection GaiaVirtualGatewayMgmtConnectionArgs
    Management connection configurations mgmt_connection blocks are documented below.
    OneTimePassword string
    One time password, used for the secure internal communication with the Management object
    ResourceId float64
    Virtual gateway identifier can be an integer or the next avaliable id (auto)
    Resources GaiaVirtualGatewayResourcesArgs
    Additional resources resources blocks are documented below.
    SetIfExist bool
    If another virtual gateway with the same identifier already exists, it will be updated. The command behaviour will be the same as if originally a set command was called. Pay attention that original virtual gateway's fields will be overwritten by the fields provided in the request payload!
    Status string
    Computed field, returned in the response.
    VirtualSwitches []float64
    Virtual switche(s) to be connected, mgmt-switch (id 500) is set as default virtual_switches blocks are documented below.
    VsId float64
    Computed field, returned in the response.
    VsxdTaskId string
    Computed field, returned in the response.
    action string
    Computed field, returned in the response.
    debug bool
    Enable debug logging for this resource.
    gaia_virtual_gateway_id string
    interfaces list(string)
    Network interface(s) to be attached interfaces blocks are documented below.
    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
    message string
    Computed field, returned in the response.
    mgmt_connection object
    Management connection configurations mgmt_connection blocks are documented below.
    one_time_password string
    One time password, used for the secure internal communication with the Management object
    resource_id number
    Virtual gateway identifier can be an integer or the next avaliable id (auto)
    resources object
    Additional resources resources blocks are documented below.
    set_if_exist bool
    If another virtual gateway with the same identifier already exists, it will be updated. The command behaviour will be the same as if originally a set command was called. Pay attention that original virtual gateway's fields will be overwritten by the fields provided in the request payload!
    status string
    Computed field, returned in the response.
    virtual_switches list(number)
    Virtual switche(s) to be connected, mgmt-switch (id 500) is set as default virtual_switches blocks are documented below.
    vs_id number
    Computed field, returned in the response.
    vsxd_task_id string
    Computed field, returned in the response.
    action String
    Computed field, returned in the response.
    debug Boolean
    Enable debug logging for this resource.
    gaiaVirtualGatewayId String
    interfaces List<String>
    Network interface(s) to be attached interfaces blocks are documented below.
    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
    message String
    Computed field, returned in the response.
    mgmtConnection GaiaVirtualGatewayMgmtConnection
    Management connection configurations mgmt_connection blocks are documented below.
    oneTimePassword String
    One time password, used for the secure internal communication with the Management object
    resourceId Double
    Virtual gateway identifier can be an integer or the next avaliable id (auto)
    resources GaiaVirtualGatewayResources
    Additional resources resources blocks are documented below.
    setIfExist Boolean
    If another virtual gateway with the same identifier already exists, it will be updated. The command behaviour will be the same as if originally a set command was called. Pay attention that original virtual gateway's fields will be overwritten by the fields provided in the request payload!
    status String
    Computed field, returned in the response.
    virtualSwitches List<Double>
    Virtual switche(s) to be connected, mgmt-switch (id 500) is set as default virtual_switches blocks are documented below.
    vsId Double
    Computed field, returned in the response.
    vsxdTaskId String
    Computed field, returned in the response.
    action string
    Computed field, returned in the response.
    debug boolean
    Enable debug logging for this resource.
    gaiaVirtualGatewayId string
    interfaces string[]
    Network interface(s) to be attached interfaces blocks are documented below.
    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
    message string
    Computed field, returned in the response.
    mgmtConnection GaiaVirtualGatewayMgmtConnection
    Management connection configurations mgmt_connection blocks are documented below.
    oneTimePassword string
    One time password, used for the secure internal communication with the Management object
    resourceId number
    Virtual gateway identifier can be an integer or the next avaliable id (auto)
    resources GaiaVirtualGatewayResources
    Additional resources resources blocks are documented below.
    setIfExist boolean
    If another virtual gateway with the same identifier already exists, it will be updated. The command behaviour will be the same as if originally a set command was called. Pay attention that original virtual gateway's fields will be overwritten by the fields provided in the request payload!
    status string
    Computed field, returned in the response.
    virtualSwitches number[]
    Virtual switche(s) to be connected, mgmt-switch (id 500) is set as default virtual_switches blocks are documented below.
    vsId number
    Computed field, returned in the response.
    vsxdTaskId string
    Computed field, returned in the response.
    action str
    Computed field, returned in the response.
    debug bool
    Enable debug logging for this resource.
    gaia_virtual_gateway_id str
    interfaces Sequence[str]
    Network interface(s) to be attached interfaces blocks are documented below.
    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
    message str
    Computed field, returned in the response.
    mgmt_connection GaiaVirtualGatewayMgmtConnectionArgs
    Management connection configurations mgmt_connection blocks are documented below.
    one_time_password str
    One time password, used for the secure internal communication with the Management object
    resource_id float
    Virtual gateway identifier can be an integer or the next avaliable id (auto)
    resources GaiaVirtualGatewayResourcesArgs
    Additional resources resources blocks are documented below.
    set_if_exist bool
    If another virtual gateway with the same identifier already exists, it will be updated. The command behaviour will be the same as if originally a set command was called. Pay attention that original virtual gateway's fields will be overwritten by the fields provided in the request payload!
    status str
    Computed field, returned in the response.
    virtual_switches Sequence[float]
    Virtual switche(s) to be connected, mgmt-switch (id 500) is set as default virtual_switches blocks are documented below.
    vs_id float
    Computed field, returned in the response.
    vsxd_task_id str
    Computed field, returned in the response.
    action String
    Computed field, returned in the response.
    debug Boolean
    Enable debug logging for this resource.
    gaiaVirtualGatewayId String
    interfaces List<String>
    Network interface(s) to be attached interfaces blocks are documented below.
    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
    message String
    Computed field, returned in the response.
    mgmtConnection Property Map
    Management connection configurations mgmt_connection blocks are documented below.
    oneTimePassword String
    One time password, used for the secure internal communication with the Management object
    resourceId Number
    Virtual gateway identifier can be an integer or the next avaliable id (auto)
    resources Property Map
    Additional resources resources blocks are documented below.
    setIfExist Boolean
    If another virtual gateway with the same identifier already exists, it will be updated. The command behaviour will be the same as if originally a set command was called. Pay attention that original virtual gateway's fields will be overwritten by the fields provided in the request payload!
    status String
    Computed field, returned in the response.
    virtualSwitches List<Number>
    Virtual switche(s) to be connected, mgmt-switch (id 500) is set as default virtual_switches blocks are documented below.
    vsId Number
    Computed field, returned in the response.
    vsxdTaskId String
    Computed field, returned in the response.

    Supporting Types

    GaiaVirtualGatewayMgmtConnection, GaiaVirtualGatewayMgmtConnectionArgs

    MgmtConnectionIdentifier string
    Management connection identifier according to the connection type (interface or virtual-switch (id or name))
    MgmtConnectionType string
    Management connection type - interface or virtual link connected to virtual-switch (identified by name or id)
    MgmtIpv4Configuration GaiaVirtualGatewayMgmtConnectionMgmtIpv4Configuration
    Management IPv4 configuration mgmt_ipv4_configuration blocks are documented below.
    MgmtIpv6Configuration GaiaVirtualGatewayMgmtConnectionMgmtIpv6Configuration
    Management IPv6 configuration mgmt_ipv6_configuration blocks are documented below.
    MgmtConnectionIdentifier string
    Management connection identifier according to the connection type (interface or virtual-switch (id or name))
    MgmtConnectionType string
    Management connection type - interface or virtual link connected to virtual-switch (identified by name or id)
    MgmtIpv4Configuration GaiaVirtualGatewayMgmtConnectionMgmtIpv4Configuration
    Management IPv4 configuration mgmt_ipv4_configuration blocks are documented below.
    MgmtIpv6Configuration GaiaVirtualGatewayMgmtConnectionMgmtIpv6Configuration
    Management IPv6 configuration mgmt_ipv6_configuration blocks are documented below.
    mgmt_connection_identifier string
    Management connection identifier according to the connection type (interface or virtual-switch (id or name))
    mgmt_connection_type string
    Management connection type - interface or virtual link connected to virtual-switch (identified by name or id)
    mgmt_ipv4_configuration object
    Management IPv4 configuration mgmt_ipv4_configuration blocks are documented below.
    mgmt_ipv6_configuration object
    Management IPv6 configuration mgmt_ipv6_configuration blocks are documented below.
    mgmtConnectionIdentifier String
    Management connection identifier according to the connection type (interface or virtual-switch (id or name))
    mgmtConnectionType String
    Management connection type - interface or virtual link connected to virtual-switch (identified by name or id)
    mgmtIpv4Configuration GaiaVirtualGatewayMgmtConnectionMgmtIpv4Configuration
    Management IPv4 configuration mgmt_ipv4_configuration blocks are documented below.
    mgmtIpv6Configuration GaiaVirtualGatewayMgmtConnectionMgmtIpv6Configuration
    Management IPv6 configuration mgmt_ipv6_configuration blocks are documented below.
    mgmtConnectionIdentifier string
    Management connection identifier according to the connection type (interface or virtual-switch (id or name))
    mgmtConnectionType string
    Management connection type - interface or virtual link connected to virtual-switch (identified by name or id)
    mgmtIpv4Configuration GaiaVirtualGatewayMgmtConnectionMgmtIpv4Configuration
    Management IPv4 configuration mgmt_ipv4_configuration blocks are documented below.
    mgmtIpv6Configuration GaiaVirtualGatewayMgmtConnectionMgmtIpv6Configuration
    Management IPv6 configuration mgmt_ipv6_configuration blocks are documented below.
    mgmt_connection_identifier str
    Management connection identifier according to the connection type (interface or virtual-switch (id or name))
    mgmt_connection_type str
    Management connection type - interface or virtual link connected to virtual-switch (identified by name or id)
    mgmt_ipv4_configuration GaiaVirtualGatewayMgmtConnectionMgmtIpv4Configuration
    Management IPv4 configuration mgmt_ipv4_configuration blocks are documented below.
    mgmt_ipv6_configuration GaiaVirtualGatewayMgmtConnectionMgmtIpv6Configuration
    Management IPv6 configuration mgmt_ipv6_configuration blocks are documented below.
    mgmtConnectionIdentifier String
    Management connection identifier according to the connection type (interface or virtual-switch (id or name))
    mgmtConnectionType String
    Management connection type - interface or virtual link connected to virtual-switch (identified by name or id)
    mgmtIpv4Configuration Property Map
    Management IPv4 configuration mgmt_ipv4_configuration blocks are documented below.
    mgmtIpv6Configuration Property Map
    Management IPv6 configuration mgmt_ipv6_configuration blocks are documented below.

    GaiaVirtualGatewayMgmtConnectionMgmtIpv4Configuration, GaiaVirtualGatewayMgmtConnectionMgmtIpv4ConfigurationArgs

    Ipv4Address string
    IPv4 address
    Ipv4DefaultGateway string
    IPv4 default gateway
    Ipv4Mask double
    IPv4 mask
    Ipv4Address string
    IPv4 address
    Ipv4DefaultGateway string
    IPv4 default gateway
    Ipv4Mask float64
    IPv4 mask
    ipv4_address string
    IPv4 address
    ipv4_default_gateway string
    IPv4 default gateway
    ipv4_mask number
    IPv4 mask
    ipv4Address String
    IPv4 address
    ipv4DefaultGateway String
    IPv4 default gateway
    ipv4Mask Double
    IPv4 mask
    ipv4Address string
    IPv4 address
    ipv4DefaultGateway string
    IPv4 default gateway
    ipv4Mask number
    IPv4 mask
    ipv4_address str
    IPv4 address
    ipv4_default_gateway str
    IPv4 default gateway
    ipv4_mask float
    IPv4 mask
    ipv4Address String
    IPv4 address
    ipv4DefaultGateway String
    IPv4 default gateway
    ipv4Mask Number
    IPv4 mask

    GaiaVirtualGatewayMgmtConnectionMgmtIpv6Configuration, GaiaVirtualGatewayMgmtConnectionMgmtIpv6ConfigurationArgs

    Ipv6Address string
    IPv6 address
    Ipv6DefaultGateway string
    IPv6 default gateway
    Ipv6Mask double
    IPv6 mask length
    Ipv6Address string
    IPv6 address
    Ipv6DefaultGateway string
    IPv6 default gateway
    Ipv6Mask float64
    IPv6 mask length
    ipv6_address string
    IPv6 address
    ipv6_default_gateway string
    IPv6 default gateway
    ipv6_mask number
    IPv6 mask length
    ipv6Address String
    IPv6 address
    ipv6DefaultGateway String
    IPv6 default gateway
    ipv6Mask Double
    IPv6 mask length
    ipv6Address string
    IPv6 address
    ipv6DefaultGateway string
    IPv6 default gateway
    ipv6Mask number
    IPv6 mask length
    ipv6_address str
    IPv6 address
    ipv6_default_gateway str
    IPv6 default gateway
    ipv6_mask float
    IPv6 mask length
    ipv6Address String
    IPv6 address
    ipv6DefaultGateway String
    IPv6 default gateway
    ipv6Mask Number
    IPv6 mask length

    GaiaVirtualGatewayResources, GaiaVirtualGatewayResourcesArgs

    FirewallIpv4Instances double
    CoreXL IPv4 instances amount. Must be between 1 and the greater of 32 and the number of CPU cores.
    FirewallIpv6Instances double
    CoreXL IPv6 instances amount. Must be between 0 and the greater of 32 and the number of CPU cores. Must not exceed the number of IPv4 CoreXL instances.
    FirewallIpv4Instances float64
    CoreXL IPv4 instances amount. Must be between 1 and the greater of 32 and the number of CPU cores.
    FirewallIpv6Instances float64
    CoreXL IPv6 instances amount. Must be between 0 and the greater of 32 and the number of CPU cores. Must not exceed the number of IPv4 CoreXL instances.
    firewall_ipv4_instances number
    CoreXL IPv4 instances amount. Must be between 1 and the greater of 32 and the number of CPU cores.
    firewall_ipv6_instances number
    CoreXL IPv6 instances amount. Must be between 0 and the greater of 32 and the number of CPU cores. Must not exceed the number of IPv4 CoreXL instances.
    firewallIpv4Instances Double
    CoreXL IPv4 instances amount. Must be between 1 and the greater of 32 and the number of CPU cores.
    firewallIpv6Instances Double
    CoreXL IPv6 instances amount. Must be between 0 and the greater of 32 and the number of CPU cores. Must not exceed the number of IPv4 CoreXL instances.
    firewallIpv4Instances number
    CoreXL IPv4 instances amount. Must be between 1 and the greater of 32 and the number of CPU cores.
    firewallIpv6Instances number
    CoreXL IPv6 instances amount. Must be between 0 and the greater of 32 and the number of CPU cores. Must not exceed the number of IPv4 CoreXL instances.
    firewall_ipv4_instances float
    CoreXL IPv4 instances amount. Must be between 1 and the greater of 32 and the number of CPU cores.
    firewall_ipv6_instances float
    CoreXL IPv6 instances amount. Must be between 0 and the greater of 32 and the number of CPU cores. Must not exceed the number of IPv4 CoreXL instances.
    firewallIpv4Instances Number
    CoreXL IPv4 instances amount. Must be between 1 and the greater of 32 and the number of CPU cores.
    firewallIpv6Instances Number
    CoreXL IPv6 instances amount. Must be between 0 and the greater of 32 and the number of CPU cores. Must not exceed the number of IPv4 CoreXL instances.

    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