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

checkpoint.GaiaVirtualSwitch

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 Switch.

    Example Usage

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

const example = new checkpoint.GaiaVirtualSwitch("example", {
    resourceId: "1",
    name: "DMZ-Switch",
});

    import pulumi
import pulumi_checkpoint as checkpoint

example = checkpoint.GaiaVirtualSwitch("example",
    resource_id="1",
    name="DMZ-Switch")

    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.NewGaiaVirtualSwitch(ctx, "example", &checkpoint.GaiaVirtualSwitchArgs{
			ResourceId: pulumi.String("1"),
			Name:       pulumi.String("DMZ-Switch"),
		})
		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.GaiaVirtualSwitch("example", new()
    {
        ResourceId = "1",
        Name = "DMZ-Switch",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.checkpoint.GaiaVirtualSwitch;
import com.pulumi.checkpoint.GaiaVirtualSwitchArgs;
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 GaiaVirtualSwitch("example", GaiaVirtualSwitchArgs.builder()
            .resourceId("1")
            .name("DMZ-Switch")
            .build());

    }
}

    resources:
  example:
    type: checkpoint:GaiaVirtualSwitch
    properties:
      resourceId: 1
      name: DMZ-Switch

    Example coming soon!

    Create GaiaVirtualSwitch Resource

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

    Constructor syntax

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

@overload
def GaiaVirtualSwitch(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      resource_id: Optional[str] = None,
                      debug: Optional[bool] = None,
                      gaia_virtual_switch_id: Optional[str] = None,
                      interface: Optional[str] = None,
                      member_id: Optional[str] = None,
                      name: Optional[str] = None,
                      set_if_exist: Optional[bool] = None)
    func NewGaiaVirtualSwitch(ctx *Context, name string, args GaiaVirtualSwitchArgs, opts ...ResourceOption) (*GaiaVirtualSwitch, error)
    public GaiaVirtualSwitch(string name, GaiaVirtualSwitchArgs args, CustomResourceOptions? opts = null)
    public GaiaVirtualSwitch(String name, GaiaVirtualSwitchArgs args)
public GaiaVirtualSwitch(String name, GaiaVirtualSwitchArgs args, CustomResourceOptions options)

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


    resource "checkpoint_gaiavirtualswitch" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args GaiaVirtualSwitchArgs
    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 GaiaVirtualSwitchArgs
    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 GaiaVirtualSwitchArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GaiaVirtualSwitchArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GaiaVirtualSwitchArgs
    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 gaiaVirtualSwitchResource = new Checkpoint.GaiaVirtualSwitch("gaiaVirtualSwitchResource", new()
{
    ResourceId = "string",
    Debug = false,
    GaiaVirtualSwitchId = "string",
    Interface = "string",
    MemberId = "string",
    Name = "string",
    SetIfExist = false,
});

    example, err := checkpoint.NewGaiaVirtualSwitch(ctx, "gaiaVirtualSwitchResource", &checkpoint.GaiaVirtualSwitchArgs{
	ResourceId:          pulumi.String("string"),
	Debug:               pulumi.Bool(false),
	GaiaVirtualSwitchId: pulumi.String("string"),
	Interface:           pulumi.String("string"),
	MemberId:            pulumi.String("string"),
	Name:                pulumi.String("string"),
	SetIfExist:          pulumi.Bool(false),
})

    resource "checkpoint_gaiavirtualswitch" "gaiaVirtualSwitchResource" {
  resource_id            = "string"
  debug                  = false
  gaia_virtual_switch_id = "string"
  interface              = "string"
  member_id              = "string"
  name                   = "string"
  set_if_exist           = false
}

    var gaiaVirtualSwitchResource = new GaiaVirtualSwitch("gaiaVirtualSwitchResource", GaiaVirtualSwitchArgs.builder()
    .resourceId("string")
    .debug(false)
    .gaiaVirtualSwitchId("string")
    .interface_("string")
    .memberId("string")
    .name("string")
    .setIfExist(false)
    .build());

    gaia_virtual_switch_resource = checkpoint.GaiaVirtualSwitch("gaiaVirtualSwitchResource",
    resource_id="string",
    debug=False,
    gaia_virtual_switch_id="string",
    interface="string",
    member_id="string",
    name="string",
    set_if_exist=False)

    const gaiaVirtualSwitchResource = new checkpoint.GaiaVirtualSwitch("gaiaVirtualSwitchResource", {
    resourceId: "string",
    debug: false,
    gaiaVirtualSwitchId: "string",
    "interface": "string",
    memberId: "string",
    name: "string",
    setIfExist: false,
});

    type: checkpoint:GaiaVirtualSwitch
properties:
    debug: false
    gaiaVirtualSwitchId: string
    interface: string
    memberId: string
    name: string
    resourceId: string
    setIfExist: false

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

    ResourceId string
    Virtual switch identifier
    Debug bool
    Enable debug logging for this resource.
    GaiaVirtualSwitchId string
    Interface string
    Network interface to be added
    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
    Virtual switch name
    SetIfExist bool
    If another virtual switch 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 switch's fields will be overwritten by the fields provided in the request payload!
    ResourceId string
    Virtual switch identifier
    Debug bool
    Enable debug logging for this resource.
    GaiaVirtualSwitchId string
    Interface string
    Network interface to be added
    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
    Virtual switch name
    SetIfExist bool
    If another virtual switch 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 switch's fields will be overwritten by the fields provided in the request payload!
    resource_id string
    Virtual switch identifier
    debug bool
    Enable debug logging for this resource.
    gaia_virtual_switch_id string
    interface string
    Network interface to be added
    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
    Virtual switch name
    set_if_exist bool
    If another virtual switch 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 switch's fields will be overwritten by the fields provided in the request payload!
    resourceId String
    Virtual switch identifier
    debug Boolean
    Enable debug logging for this resource.
    gaiaVirtualSwitchId String
    interface_ String
    Network interface to be added
    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
    Virtual switch name
    setIfExist Boolean
    If another virtual switch 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 switch's fields will be overwritten by the fields provided in the request payload!
    resourceId string
    Virtual switch identifier
    debug boolean
    Enable debug logging for this resource.
    gaiaVirtualSwitchId string
    interface string
    Network interface to be added
    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
    Virtual switch name
    setIfExist boolean
    If another virtual switch 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 switch's fields will be overwritten by the fields provided in the request payload!
    resource_id str
    Virtual switch identifier
    debug bool
    Enable debug logging for this resource.
    gaia_virtual_switch_id str
    interface str
    Network interface to be added
    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
    Virtual switch name
    set_if_exist bool
    If another virtual switch 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 switch's fields will be overwritten by the fields provided in the request payload!
    resourceId String
    Virtual switch identifier
    debug Boolean
    Enable debug logging for this resource.
    gaiaVirtualSwitchId String
    interface String
    Network interface to be added
    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
    Virtual switch name
    setIfExist Boolean
    If another virtual switch 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 switch's fields will be overwritten by the fields provided in the request payload!

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GaiaVirtualSwitch 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 GaiaVirtualSwitch Resource

    Get an existing GaiaVirtualSwitch 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?: GaiaVirtualSwitchState, opts?: CustomResourceOptions): GaiaVirtualSwitch
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action: Optional[str] = None,
        debug: Optional[bool] = None,
        gaia_virtual_switch_id: Optional[str] = None,
        interface: Optional[str] = None,
        member_id: Optional[str] = None,
        message: Optional[str] = None,
        name: Optional[str] = None,
        resource_id: Optional[str] = None,
        set_if_exist: Optional[bool] = None,
        status: Optional[str] = None,
        vs_id: Optional[float] = None,
        vsxd_task_id: Optional[str] = None) -> GaiaVirtualSwitch
    func GetGaiaVirtualSwitch(ctx *Context, name string, id IDInput, state *GaiaVirtualSwitchState, opts ...ResourceOption) (*GaiaVirtualSwitch, error)
    public static GaiaVirtualSwitch Get(string name, Input<string> id, GaiaVirtualSwitchState? state, CustomResourceOptions? opts = null)
    public static GaiaVirtualSwitch get(String name, Output<String> id, GaiaVirtualSwitchState state, CustomResourceOptions options)
    resources:  _:    type: checkpoint:GaiaVirtualSwitch    get:      id: ${id}
    import {
  to = checkpoint_gaiavirtualswitch.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.
    GaiaVirtualSwitchId string
    Interface string
    Network interface to be added
    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.
    Name string
    Virtual switch name
    ResourceId string
    Virtual switch identifier
    SetIfExist bool
    If another virtual switch 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 switch's fields will be overwritten by the fields provided in the request payload!
    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.
    Debug bool
    Enable debug logging for this resource.
    GaiaVirtualSwitchId string
    Interface string
    Network interface to be added
    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.
    Name string
    Virtual switch name
    ResourceId string
    Virtual switch identifier
    SetIfExist bool
    If another virtual switch 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 switch's fields will be overwritten by the fields provided in the request payload!
    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.
    debug bool
    Enable debug logging for this resource.
    gaia_virtual_switch_id string
    interface string
    Network interface to be added
    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.
    name string
    Virtual switch name
    resource_id string
    Virtual switch identifier
    set_if_exist bool
    If another virtual switch 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 switch's fields will be overwritten by the fields provided in the request payload!
    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.
    debug Boolean
    Enable debug logging for this resource.
    gaiaVirtualSwitchId String
    interface_ String
    Network interface to be added
    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.
    name String
    Virtual switch name
    resourceId String
    Virtual switch identifier
    setIfExist Boolean
    If another virtual switch 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 switch's fields will be overwritten by the fields provided in the request payload!
    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.
    debug boolean
    Enable debug logging for this resource.
    gaiaVirtualSwitchId string
    interface string
    Network interface to be added
    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.
    name string
    Virtual switch name
    resourceId string
    Virtual switch identifier
    setIfExist boolean
    If another virtual switch 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 switch's fields will be overwritten by the fields provided in the request payload!
    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.
    debug bool
    Enable debug logging for this resource.
    gaia_virtual_switch_id str
    interface str
    Network interface to be added
    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.
    name str
    Virtual switch name
    resource_id str
    Virtual switch identifier
    set_if_exist bool
    If another virtual switch 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 switch's fields will be overwritten by the fields provided in the request payload!
    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.
    debug Boolean
    Enable debug logging for this resource.
    gaiaVirtualSwitchId String
    interface String
    Network interface to be added
    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.
    name String
    Virtual switch name
    resourceId String
    Virtual switch identifier
    setIfExist Boolean
    If another virtual switch 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 switch's fields will be overwritten by the fields provided in the request payload!
    status String
    Computed field, returned in the response.
    vsId Number
    Computed field, returned in the response.
    vsxdTaskId String
    Computed field, returned in the response.

    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