published on Monday, Jun 15, 2026 by checkpointsw
published on Monday, Jun 15, 2026 by checkpointsw
This resource allows you to execute Check Point Role.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as checkpoint from "@pulumi/checkpoint";
const example = new checkpoint.GaiaRole("example", {
name: "myrole",
extendedCommands: ["ifconfig"],
features: [
{
name: "bgp",
permission: "read-write",
},
{
name: "dhcp",
permission: "read-write",
},
{
name: "igmp",
permission: "read-write",
},
{
name: "ntp",
permission: "read-write",
},
{
name: "syslog",
permission: "read-write",
},
{
name: "backup",
permission: "read-only",
},
],
});
import pulumi
import pulumi_checkpoint as checkpoint
example = checkpoint.GaiaRole("example",
name="myrole",
extended_commands=["ifconfig"],
features=[
{
"name": "bgp",
"permission": "read-write",
},
{
"name": "dhcp",
"permission": "read-write",
},
{
"name": "igmp",
"permission": "read-write",
},
{
"name": "ntp",
"permission": "read-write",
},
{
"name": "syslog",
"permission": "read-write",
},
{
"name": "backup",
"permission": "read-only",
},
])
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.NewGaiaRole(ctx, "example", &checkpoint.GaiaRoleArgs{
Name: pulumi.String("myrole"),
ExtendedCommands: pulumi.StringArray{
pulumi.String("ifconfig"),
},
Features: checkpoint.GaiaRoleFeatureArray{
&checkpoint.GaiaRoleFeatureArgs{
Name: pulumi.String("bgp"),
Permission: pulumi.String("read-write"),
},
&checkpoint.GaiaRoleFeatureArgs{
Name: pulumi.String("dhcp"),
Permission: pulumi.String("read-write"),
},
&checkpoint.GaiaRoleFeatureArgs{
Name: pulumi.String("igmp"),
Permission: pulumi.String("read-write"),
},
&checkpoint.GaiaRoleFeatureArgs{
Name: pulumi.String("ntp"),
Permission: pulumi.String("read-write"),
},
&checkpoint.GaiaRoleFeatureArgs{
Name: pulumi.String("syslog"),
Permission: pulumi.String("read-write"),
},
&checkpoint.GaiaRoleFeatureArgs{
Name: pulumi.String("backup"),
Permission: pulumi.String("read-only"),
},
},
})
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.GaiaRole("example", new()
{
Name = "myrole",
ExtendedCommands = new[]
{
"ifconfig",
},
Features = new[]
{
new Checkpoint.Inputs.GaiaRoleFeatureArgs
{
Name = "bgp",
Permission = "read-write",
},
new Checkpoint.Inputs.GaiaRoleFeatureArgs
{
Name = "dhcp",
Permission = "read-write",
},
new Checkpoint.Inputs.GaiaRoleFeatureArgs
{
Name = "igmp",
Permission = "read-write",
},
new Checkpoint.Inputs.GaiaRoleFeatureArgs
{
Name = "ntp",
Permission = "read-write",
},
new Checkpoint.Inputs.GaiaRoleFeatureArgs
{
Name = "syslog",
Permission = "read-write",
},
new Checkpoint.Inputs.GaiaRoleFeatureArgs
{
Name = "backup",
Permission = "read-only",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.checkpoint.GaiaRole;
import com.pulumi.checkpoint.GaiaRoleArgs;
import com.pulumi.checkpoint.inputs.GaiaRoleFeatureArgs;
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 GaiaRole("example", GaiaRoleArgs.builder()
.name("myrole")
.extendedCommands("ifconfig")
.features(
GaiaRoleFeatureArgs.builder()
.name("bgp")
.permission("read-write")
.build(),
GaiaRoleFeatureArgs.builder()
.name("dhcp")
.permission("read-write")
.build(),
GaiaRoleFeatureArgs.builder()
.name("igmp")
.permission("read-write")
.build(),
GaiaRoleFeatureArgs.builder()
.name("ntp")
.permission("read-write")
.build(),
GaiaRoleFeatureArgs.builder()
.name("syslog")
.permission("read-write")
.build(),
GaiaRoleFeatureArgs.builder()
.name("backup")
.permission("read-only")
.build())
.build());
}
}
resources:
example:
type: checkpoint:GaiaRole
properties:
name: myrole
extendedCommands:
- ifconfig
features:
- name: bgp
permission: read-write
- name: dhcp
permission: read-write
- name: igmp
permission: read-write
- name: ntp
permission: read-write
- name: syslog
permission: read-write
- name: backup
permission: read-only
Example coming soon!
Create GaiaRole Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GaiaRole(name: string, args?: GaiaRoleArgs, opts?: CustomResourceOptions);@overload
def GaiaRole(resource_name: str,
args: Optional[GaiaRoleArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def GaiaRole(resource_name: str,
opts: Optional[ResourceOptions] = None,
debug: Optional[bool] = None,
extended_commands: Optional[Sequence[str]] = None,
features: Optional[Sequence[GaiaRoleFeatureArgs]] = None,
gaia_role_id: Optional[str] = None,
member_id: Optional[str] = None,
name: Optional[str] = None)func NewGaiaRole(ctx *Context, name string, args *GaiaRoleArgs, opts ...ResourceOption) (*GaiaRole, error)public GaiaRole(string name, GaiaRoleArgs? args = null, CustomResourceOptions? opts = null)
public GaiaRole(String name, GaiaRoleArgs args)
public GaiaRole(String name, GaiaRoleArgs args, CustomResourceOptions options)
type: checkpoint:GaiaRole
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "checkpoint_gaiarole" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args GaiaRoleArgs
- 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 GaiaRoleArgs
- 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 GaiaRoleArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GaiaRoleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GaiaRoleArgs
- 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 gaiaRoleResource = new Checkpoint.GaiaRole("gaiaRoleResource", new()
{
Debug = false,
ExtendedCommands = new[]
{
"string",
},
Features = new[]
{
new Checkpoint.Inputs.GaiaRoleFeatureArgs
{
Name = "string",
Permission = "string",
},
},
GaiaRoleId = "string",
MemberId = "string",
Name = "string",
});
example, err := checkpoint.NewGaiaRole(ctx, "gaiaRoleResource", &checkpoint.GaiaRoleArgs{
Debug: pulumi.Bool(false),
ExtendedCommands: pulumi.StringArray{
pulumi.String("string"),
},
Features: checkpoint.GaiaRoleFeatureArray{
&checkpoint.GaiaRoleFeatureArgs{
Name: pulumi.String("string"),
Permission: pulumi.String("string"),
},
},
GaiaRoleId: pulumi.String("string"),
MemberId: pulumi.String("string"),
Name: pulumi.String("string"),
})
resource "checkpoint_gaiarole" "gaiaRoleResource" {
debug = false
extended_commands = ["string"]
features {
name = "string"
permission = "string"
}
gaia_role_id = "string"
member_id = "string"
name = "string"
}
var gaiaRoleResource = new GaiaRole("gaiaRoleResource", GaiaRoleArgs.builder()
.debug(false)
.extendedCommands("string")
.features(GaiaRoleFeatureArgs.builder()
.name("string")
.permission("string")
.build())
.gaiaRoleId("string")
.memberId("string")
.name("string")
.build());
gaia_role_resource = checkpoint.GaiaRole("gaiaRoleResource",
debug=False,
extended_commands=["string"],
features=[{
"name": "string",
"permission": "string",
}],
gaia_role_id="string",
member_id="string",
name="string")
const gaiaRoleResource = new checkpoint.GaiaRole("gaiaRoleResource", {
debug: false,
extendedCommands: ["string"],
features: [{
name: "string",
permission: "string",
}],
gaiaRoleId: "string",
memberId: "string",
name: "string",
});
type: checkpoint:GaiaRole
properties:
debug: false
extendedCommands:
- string
features:
- name: string
permission: string
gaiaRoleId: string
memberId: string
name: string
GaiaRole 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 GaiaRole resource accepts the following input properties:
- Debug bool
- Enable debug logging for this resource.
- Extended
Commands List<string> - Specifies which extended commands will be assigned to the role.Valid values: extended commands as shown in show-extended-commands API output or 'all' to specify all extended-commands. extended_commands blocks are documented below.
- Features
List<Gaia
Role Feature> - Specifies which features will be assigned to the role. features blocks are documented below.
- Gaia
Role stringId - 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
- Role name
- Debug bool
- Enable debug logging for this resource.
- Extended
Commands []string - Specifies which extended commands will be assigned to the role.Valid values: extended commands as shown in show-extended-commands API output or 'all' to specify all extended-commands. extended_commands blocks are documented below.
- Features
[]Gaia
Role Feature Args - Specifies which features will be assigned to the role. features blocks are documented below.
- Gaia
Role stringId - 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
- Role name
- debug bool
- Enable debug logging for this resource.
- extended_
commands list(string) - Specifies which extended commands will be assigned to the role.Valid values: extended commands as shown in show-extended-commands API output or 'all' to specify all extended-commands. extended_commands blocks are documented below.
- features list(object)
- Specifies which features will be assigned to the role. features blocks are documented below.
- gaia_
role_ stringid - 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
- Role name
- debug Boolean
- Enable debug logging for this resource.
- extended
Commands List<String> - Specifies which extended commands will be assigned to the role.Valid values: extended commands as shown in show-extended-commands API output or 'all' to specify all extended-commands. extended_commands blocks are documented below.
- features
List<Gaia
Role Feature> - Specifies which features will be assigned to the role. features blocks are documented below.
- gaia
Role StringId - 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
- Role name
- debug boolean
- Enable debug logging for this resource.
- extended
Commands string[] - Specifies which extended commands will be assigned to the role.Valid values: extended commands as shown in show-extended-commands API output or 'all' to specify all extended-commands. extended_commands blocks are documented below.
- features
Gaia
Role Feature[] - Specifies which features will be assigned to the role. features blocks are documented below.
- gaia
Role stringId - 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
- Role name
- debug bool
- Enable debug logging for this resource.
- extended_
commands Sequence[str] - Specifies which extended commands will be assigned to the role.Valid values: extended commands as shown in show-extended-commands API output or 'all' to specify all extended-commands. extended_commands blocks are documented below.
- features
Sequence[Gaia
Role Feature Args] - Specifies which features will be assigned to the role. features blocks are documented below.
- gaia_
role_ strid - 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
- Role name
- debug Boolean
- Enable debug logging for this resource.
- extended
Commands List<String> - Specifies which extended commands will be assigned to the role.Valid values: extended commands as shown in show-extended-commands API output or 'all' to specify all extended-commands. extended_commands blocks are documented below.
- features List<Property Map>
- Specifies which features will be assigned to the role. features blocks are documented below.
- gaia
Role StringId - 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
- Role name
Outputs
All input properties are implicitly available as output properties. Additionally, the GaiaRole resource produces the following output properties:
Look up Existing GaiaRole Resource
Get an existing GaiaRole 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?: GaiaRoleState, opts?: CustomResourceOptions): GaiaRole@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
debug: Optional[bool] = None,
extended_commands: Optional[Sequence[str]] = None,
features: Optional[Sequence[GaiaRoleFeatureArgs]] = None,
gaia_role_id: Optional[str] = None,
member_id: Optional[str] = None,
name: Optional[str] = None,
users: Optional[Sequence[str]] = None) -> GaiaRolefunc GetGaiaRole(ctx *Context, name string, id IDInput, state *GaiaRoleState, opts ...ResourceOption) (*GaiaRole, error)public static GaiaRole Get(string name, Input<string> id, GaiaRoleState? state, CustomResourceOptions? opts = null)public static GaiaRole get(String name, Output<String> id, GaiaRoleState state, CustomResourceOptions options)resources: _: type: checkpoint:GaiaRole get: id: ${id}import {
to = checkpoint_gaiarole.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.
- Extended
Commands List<string> - Specifies which extended commands will be assigned to the role.Valid values: extended commands as shown in show-extended-commands API output or 'all' to specify all extended-commands. extended_commands blocks are documented below.
- Features
List<Gaia
Role Feature> - Specifies which features will be assigned to the role. features blocks are documented below.
- Gaia
Role stringId - 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
- Role name
- Users List<string>
- Computed field, returned in the response. users blocks are documented below.
- Debug bool
- Enable debug logging for this resource.
- Extended
Commands []string - Specifies which extended commands will be assigned to the role.Valid values: extended commands as shown in show-extended-commands API output or 'all' to specify all extended-commands. extended_commands blocks are documented below.
- Features
[]Gaia
Role Feature Args - Specifies which features will be assigned to the role. features blocks are documented below.
- Gaia
Role stringId - 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
- Role name
- Users []string
- Computed field, returned in the response. users blocks are documented below.
- debug bool
- Enable debug logging for this resource.
- extended_
commands list(string) - Specifies which extended commands will be assigned to the role.Valid values: extended commands as shown in show-extended-commands API output or 'all' to specify all extended-commands. extended_commands blocks are documented below.
- features list(object)
- Specifies which features will be assigned to the role. features blocks are documented below.
- gaia_
role_ stringid - 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
- Role name
- users list(string)
- Computed field, returned in the response. users blocks are documented below.
- debug Boolean
- Enable debug logging for this resource.
- extended
Commands List<String> - Specifies which extended commands will be assigned to the role.Valid values: extended commands as shown in show-extended-commands API output or 'all' to specify all extended-commands. extended_commands blocks are documented below.
- features
List<Gaia
Role Feature> - Specifies which features will be assigned to the role. features blocks are documented below.
- gaia
Role StringId - 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
- Role name
- users List<String>
- Computed field, returned in the response. users blocks are documented below.
- debug boolean
- Enable debug logging for this resource.
- extended
Commands string[] - Specifies which extended commands will be assigned to the role.Valid values: extended commands as shown in show-extended-commands API output or 'all' to specify all extended-commands. extended_commands blocks are documented below.
- features
Gaia
Role Feature[] - Specifies which features will be assigned to the role. features blocks are documented below.
- gaia
Role stringId - 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
- Role name
- users string[]
- Computed field, returned in the response. users blocks are documented below.
- debug bool
- Enable debug logging for this resource.
- extended_
commands Sequence[str] - Specifies which extended commands will be assigned to the role.Valid values: extended commands as shown in show-extended-commands API output or 'all' to specify all extended-commands. extended_commands blocks are documented below.
- features
Sequence[Gaia
Role Feature Args] - Specifies which features will be assigned to the role. features blocks are documented below.
- gaia_
role_ strid - 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
- Role name
- users Sequence[str]
- Computed field, returned in the response. users blocks are documented below.
- debug Boolean
- Enable debug logging for this resource.
- extended
Commands List<String> - Specifies which extended commands will be assigned to the role.Valid values: extended commands as shown in show-extended-commands API output or 'all' to specify all extended-commands. extended_commands blocks are documented below.
- features List<Property Map>
- Specifies which features will be assigned to the role. features blocks are documented below.
- gaia
Role StringId - 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
- Role name
- users List<String>
- Computed field, returned in the response. users blocks are documented below.
Supporting Types
GaiaRoleFeature, GaiaRoleFeatureArgs
- Name string
- Feature name. Valid values: feature name as shown in show-features API output or 'all' to specify all features.
- Permission string
- Feature permission. Valid values: read-write ,read-only.
- Name string
- Feature name. Valid values: feature name as shown in show-features API output or 'all' to specify all features.
- Permission string
- Feature permission. Valid values: read-write ,read-only.
- name string
- Feature name. Valid values: feature name as shown in show-features API output or 'all' to specify all features.
- permission string
- Feature permission. Valid values: read-write ,read-only.
- name String
- Feature name. Valid values: feature name as shown in show-features API output or 'all' to specify all features.
- permission String
- Feature permission. Valid values: read-write ,read-only.
- name string
- Feature name. Valid values: feature name as shown in show-features API output or 'all' to specify all features.
- permission string
- Feature permission. Valid values: read-write ,read-only.
- name str
- Feature name. Valid values: feature name as shown in show-features API output or 'all' to specify all features.
- permission str
- Feature permission. Valid values: read-write ,read-only.
- name String
- Feature name. Valid values: feature name as shown in show-features API output or 'all' to specify all features.
- permission String
- Feature permission. Valid values: read-write ,read-only.
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