1. Packages
  2. Packages
  3. Checkpoint Provider
  4. API Docs
  5. GaiaCommandLogin
Viewing docs for checkpoint 3.2.0
published on Monday, Jun 15, 2026 by checkpointsw
Viewing docs for checkpoint 3.2.0
published on Monday, Jun 15, 2026 by checkpointsw

    Create GaiaCommandLogin Resource

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

    Constructor syntax

    new GaiaCommandLogin(name: string, args: GaiaCommandLoginArgs, opts?: CustomResourceOptions);
    @overload
    def GaiaCommandLogin(resource_name: str,
                         args: GaiaCommandLoginArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def GaiaCommandLogin(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         password: Optional[str] = None,
                         user: Optional[str] = None,
                         debug: Optional[bool] = None,
                         gaia_command_login_id: Optional[str] = None,
                         member_id: Optional[str] = None,
                         session_timeout: Optional[float] = None,
                         verification_code: Optional[str] = None,
                         virtual_system_id: Optional[float] = None)
    func NewGaiaCommandLogin(ctx *Context, name string, args GaiaCommandLoginArgs, opts ...ResourceOption) (*GaiaCommandLogin, error)
    public GaiaCommandLogin(string name, GaiaCommandLoginArgs args, CustomResourceOptions? opts = null)
    public GaiaCommandLogin(String name, GaiaCommandLoginArgs args)
    public GaiaCommandLogin(String name, GaiaCommandLoginArgs args, CustomResourceOptions options)
    
    type: checkpoint:GaiaCommandLogin
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "checkpoint_gaiacommandlogin" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args GaiaCommandLoginArgs
    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 GaiaCommandLoginArgs
    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 GaiaCommandLoginArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GaiaCommandLoginArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GaiaCommandLoginArgs
    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 gaiaCommandLoginResource = new Checkpoint.GaiaCommandLogin("gaiaCommandLoginResource", new()
    {
        Password = "string",
        User = "string",
        Debug = false,
        GaiaCommandLoginId = "string",
        MemberId = "string",
        SessionTimeout = 0,
        VerificationCode = "string",
        VirtualSystemId = 0,
    });
    
    example, err := checkpoint.NewGaiaCommandLogin(ctx, "gaiaCommandLoginResource", &checkpoint.GaiaCommandLoginArgs{
    	Password:           pulumi.String("string"),
    	User:               pulumi.String("string"),
    	Debug:              pulumi.Bool(false),
    	GaiaCommandLoginId: pulumi.String("string"),
    	MemberId:           pulumi.String("string"),
    	SessionTimeout:     pulumi.Float64(0),
    	VerificationCode:   pulumi.String("string"),
    	VirtualSystemId:    pulumi.Float64(0),
    })
    
    resource "checkpoint_gaiacommandlogin" "gaiaCommandLoginResource" {
      password              = "string"
      user                  = "string"
      debug                 = false
      gaia_command_login_id = "string"
      member_id             = "string"
      session_timeout       = 0
      verification_code     = "string"
      virtual_system_id     = 0
    }
    
    var gaiaCommandLoginResource = new GaiaCommandLogin("gaiaCommandLoginResource", GaiaCommandLoginArgs.builder()
        .password("string")
        .user("string")
        .debug(false)
        .gaiaCommandLoginId("string")
        .memberId("string")
        .sessionTimeout(0.0)
        .verificationCode("string")
        .virtualSystemId(0.0)
        .build());
    
    gaia_command_login_resource = checkpoint.GaiaCommandLogin("gaiaCommandLoginResource",
        password="string",
        user="string",
        debug=False,
        gaia_command_login_id="string",
        member_id="string",
        session_timeout=float(0),
        verification_code="string",
        virtual_system_id=float(0))
    
    const gaiaCommandLoginResource = new checkpoint.GaiaCommandLogin("gaiaCommandLoginResource", {
        password: "string",
        user: "string",
        debug: false,
        gaiaCommandLoginId: "string",
        memberId: "string",
        sessionTimeout: 0,
        verificationCode: "string",
        virtualSystemId: 0,
    });
    
    type: checkpoint:GaiaCommandLogin
    properties:
        debug: false
        gaiaCommandLoginId: string
        memberId: string
        password: string
        sessionTimeout: 0
        user: string
        verificationCode: string
        virtualSystemId: 0
    

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

    Password string
    Administrator password
    User string
    Administrator user name
    Debug bool
    Enable debugging for this resource only.
    GaiaCommandLoginId string
    MemberId string
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    SessionTimeout double
    Session expiration timeout in seconds
    VerificationCode string
    Verification code, if Two-Factor Authentication is enabled for this user. This field must be a string comprised solely of digits.
    VirtualSystemId double
    Virtual System ID. Relevant for VSNext setups
    Password string
    Administrator password
    User string
    Administrator user name
    Debug bool
    Enable debugging for this resource only.
    GaiaCommandLoginId string
    MemberId string
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    SessionTimeout float64
    Session expiration timeout in seconds
    VerificationCode string
    Verification code, if Two-Factor Authentication is enabled for this user. This field must be a string comprised solely of digits.
    VirtualSystemId float64
    Virtual System ID. Relevant for VSNext setups
    password string
    Administrator password
    user string
    Administrator user name
    debug bool
    Enable debugging for this resource only.
    gaia_command_login_id string
    member_id string
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    session_timeout number
    Session expiration timeout in seconds
    verification_code string
    Verification code, if Two-Factor Authentication is enabled for this user. This field must be a string comprised solely of digits.
    virtual_system_id number
    Virtual System ID. Relevant for VSNext setups
    password String
    Administrator password
    user String
    Administrator user name
    debug Boolean
    Enable debugging for this resource only.
    gaiaCommandLoginId String
    memberId String
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    sessionTimeout Double
    Session expiration timeout in seconds
    verificationCode String
    Verification code, if Two-Factor Authentication is enabled for this user. This field must be a string comprised solely of digits.
    virtualSystemId Double
    Virtual System ID. Relevant for VSNext setups
    password string
    Administrator password
    user string
    Administrator user name
    debug boolean
    Enable debugging for this resource only.
    gaiaCommandLoginId string
    memberId string
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    sessionTimeout number
    Session expiration timeout in seconds
    verificationCode string
    Verification code, if Two-Factor Authentication is enabled for this user. This field must be a string comprised solely of digits.
    virtualSystemId number
    Virtual System ID. Relevant for VSNext setups
    password str
    Administrator password
    user str
    Administrator user name
    debug bool
    Enable debugging for this resource only.
    gaia_command_login_id str
    member_id str
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    session_timeout float
    Session expiration timeout in seconds
    verification_code str
    Verification code, if Two-Factor Authentication is enabled for this user. This field must be a string comprised solely of digits.
    virtual_system_id float
    Virtual System ID. Relevant for VSNext setups
    password String
    Administrator password
    user String
    Administrator user name
    debug Boolean
    Enable debugging for this resource only.
    gaiaCommandLoginId String
    memberId String
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    sessionTimeout Number
    Session expiration timeout in seconds
    verificationCode String
    Verification code, if Two-Factor Authentication is enabled for this user. This field must be a string comprised solely of digits.
    virtualSystemId Number
    Virtual System ID. Relevant for VSNext setups

    Outputs

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

    ApiServerVersion string
    N/A
    Id string
    The provider-assigned unique ID for this managed resource.
    LastLoginWasAts List<GaiaCommandLoginLastLoginWasAt>
    N/A
    ReadOnly bool
    N/A
    Sid string
    N/A
    Url string
    N/A
    ApiServerVersion string
    N/A
    Id string
    The provider-assigned unique ID for this managed resource.
    LastLoginWasAts []GaiaCommandLoginLastLoginWasAt
    N/A
    ReadOnly bool
    N/A
    Sid string
    N/A
    Url string
    N/A
    api_server_version string
    N/A
    id string
    The provider-assigned unique ID for this managed resource.
    last_login_was_ats list(object)
    N/A
    read_only bool
    N/A
    sid string
    N/A
    url string
    N/A
    apiServerVersion String
    N/A
    id String
    The provider-assigned unique ID for this managed resource.
    lastLoginWasAts List<GaiaCommandLoginLastLoginWasAt>
    N/A
    readOnly Boolean
    N/A
    sid String
    N/A
    url String
    N/A
    apiServerVersion string
    N/A
    id string
    The provider-assigned unique ID for this managed resource.
    lastLoginWasAts GaiaCommandLoginLastLoginWasAt[]
    N/A
    readOnly boolean
    N/A
    sid string
    N/A
    url string
    N/A
    api_server_version str
    N/A
    id str
    The provider-assigned unique ID for this managed resource.
    last_login_was_ats Sequence[GaiaCommandLoginLastLoginWasAt]
    N/A
    read_only bool
    N/A
    sid str
    N/A
    url str
    N/A
    apiServerVersion String
    N/A
    id String
    The provider-assigned unique ID for this managed resource.
    lastLoginWasAts List<Property Map>
    N/A
    readOnly Boolean
    N/A
    sid String
    N/A
    url String
    N/A

    Look up Existing GaiaCommandLogin Resource

    Get an existing GaiaCommandLogin 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?: GaiaCommandLoginState, opts?: CustomResourceOptions): GaiaCommandLogin
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            api_server_version: Optional[str] = None,
            debug: Optional[bool] = None,
            gaia_command_login_id: Optional[str] = None,
            last_login_was_ats: Optional[Sequence[GaiaCommandLoginLastLoginWasAtArgs]] = None,
            member_id: Optional[str] = None,
            password: Optional[str] = None,
            read_only: Optional[bool] = None,
            session_timeout: Optional[float] = None,
            sid: Optional[str] = None,
            url: Optional[str] = None,
            user: Optional[str] = None,
            verification_code: Optional[str] = None,
            virtual_system_id: Optional[float] = None) -> GaiaCommandLogin
    func GetGaiaCommandLogin(ctx *Context, name string, id IDInput, state *GaiaCommandLoginState, opts ...ResourceOption) (*GaiaCommandLogin, error)
    public static GaiaCommandLogin Get(string name, Input<string> id, GaiaCommandLoginState? state, CustomResourceOptions? opts = null)
    public static GaiaCommandLogin get(String name, Output<String> id, GaiaCommandLoginState state, CustomResourceOptions options)
    resources:  _:    type: checkpoint:GaiaCommandLogin    get:      id: ${id}
    import {
      to = checkpoint_gaiacommandlogin.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:
    ApiServerVersion string
    N/A
    Debug bool
    Enable debugging for this resource only.
    GaiaCommandLoginId string
    LastLoginWasAts List<GaiaCommandLoginLastLoginWasAt>
    N/A
    MemberId string
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    Password string
    Administrator password
    ReadOnly bool
    N/A
    SessionTimeout double
    Session expiration timeout in seconds
    Sid string
    N/A
    Url string
    N/A
    User string
    Administrator user name
    VerificationCode string
    Verification code, if Two-Factor Authentication is enabled for this user. This field must be a string comprised solely of digits.
    VirtualSystemId double
    Virtual System ID. Relevant for VSNext setups
    ApiServerVersion string
    N/A
    Debug bool
    Enable debugging for this resource only.
    GaiaCommandLoginId string
    LastLoginWasAts []GaiaCommandLoginLastLoginWasAtArgs
    N/A
    MemberId string
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    Password string
    Administrator password
    ReadOnly bool
    N/A
    SessionTimeout float64
    Session expiration timeout in seconds
    Sid string
    N/A
    Url string
    N/A
    User string
    Administrator user name
    VerificationCode string
    Verification code, if Two-Factor Authentication is enabled for this user. This field must be a string comprised solely of digits.
    VirtualSystemId float64
    Virtual System ID. Relevant for VSNext setups
    api_server_version string
    N/A
    debug bool
    Enable debugging for this resource only.
    gaia_command_login_id string
    last_login_was_ats list(object)
    N/A
    member_id string
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    password string
    Administrator password
    read_only bool
    N/A
    session_timeout number
    Session expiration timeout in seconds
    sid string
    N/A
    url string
    N/A
    user string
    Administrator user name
    verification_code string
    Verification code, if Two-Factor Authentication is enabled for this user. This field must be a string comprised solely of digits.
    virtual_system_id number
    Virtual System ID. Relevant for VSNext setups
    apiServerVersion String
    N/A
    debug Boolean
    Enable debugging for this resource only.
    gaiaCommandLoginId String
    lastLoginWasAts List<GaiaCommandLoginLastLoginWasAt>
    N/A
    memberId String
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    password String
    Administrator password
    readOnly Boolean
    N/A
    sessionTimeout Double
    Session expiration timeout in seconds
    sid String
    N/A
    url String
    N/A
    user String
    Administrator user name
    verificationCode String
    Verification code, if Two-Factor Authentication is enabled for this user. This field must be a string comprised solely of digits.
    virtualSystemId Double
    Virtual System ID. Relevant for VSNext setups
    apiServerVersion string
    N/A
    debug boolean
    Enable debugging for this resource only.
    gaiaCommandLoginId string
    lastLoginWasAts GaiaCommandLoginLastLoginWasAt[]
    N/A
    memberId string
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    password string
    Administrator password
    readOnly boolean
    N/A
    sessionTimeout number
    Session expiration timeout in seconds
    sid string
    N/A
    url string
    N/A
    user string
    Administrator user name
    verificationCode string
    Verification code, if Two-Factor Authentication is enabled for this user. This field must be a string comprised solely of digits.
    virtualSystemId number
    Virtual System ID. Relevant for VSNext setups
    api_server_version str
    N/A
    debug bool
    Enable debugging for this resource only.
    gaia_command_login_id str
    last_login_was_ats Sequence[GaiaCommandLoginLastLoginWasAtArgs]
    N/A
    member_id str
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    password str
    Administrator password
    read_only bool
    N/A
    session_timeout float
    Session expiration timeout in seconds
    sid str
    N/A
    url str
    N/A
    user str
    Administrator user name
    verification_code str
    Verification code, if Two-Factor Authentication is enabled for this user. This field must be a string comprised solely of digits.
    virtual_system_id float
    Virtual System ID. Relevant for VSNext setups
    apiServerVersion String
    N/A
    debug Boolean
    Enable debugging for this resource only.
    gaiaCommandLoginId String
    lastLoginWasAts List<Property Map>
    N/A
    memberId String
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    password String
    Administrator password
    readOnly Boolean
    N/A
    sessionTimeout Number
    Session expiration timeout in seconds
    sid String
    N/A
    url String
    N/A
    user String
    Administrator user name
    verificationCode String
    Verification code, if Two-Factor Authentication is enabled for this user. This field must be a string comprised solely of digits.
    virtualSystemId Number
    Virtual System ID. Relevant for VSNext setups

    Supporting Types

    GaiaCommandLoginLastLoginWasAt, GaiaCommandLoginLastLoginWasAtArgs

    Iso8601 string
    Posix double
    Iso8601 string
    Posix float64
    iso8601 string
    posix number
    iso8601 String
    posix Double
    iso8601 string
    posix number
    iso8601 str
    posix float
    iso8601 String
    posix Number

    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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial