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

checkpoint.GaiaCommandSetSnmpSession

Viewing docs for checkpoint 3.2.0
published on Monday, Jun 15, 2026 by checkpointsw
Schema (JSON)
checkpointsw/terraform-provider-checkpoint

    Create GaiaCommandSetSnmpSession Resource

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

    Constructor syntax

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

@overload
def GaiaCommandSetSnmpSession(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              community_string: Optional[str] = None,
                              debug: Optional[bool] = None,
                              gaia_command_set_snmp_session_id: Optional[str] = None,
                              session_timeout: Optional[float] = None,
                              v3_object: Optional[GaiaCommandSetSnmpSessionV3ObjectArgs] = None)
    func NewGaiaCommandSetSnmpSession(ctx *Context, name string, args *GaiaCommandSetSnmpSessionArgs, opts ...ResourceOption) (*GaiaCommandSetSnmpSession, error)
    public GaiaCommandSetSnmpSession(string name, GaiaCommandSetSnmpSessionArgs? args = null, CustomResourceOptions? opts = null)
    public GaiaCommandSetSnmpSession(String name, GaiaCommandSetSnmpSessionArgs args)
public GaiaCommandSetSnmpSession(String name, GaiaCommandSetSnmpSessionArgs args, CustomResourceOptions options)

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


    resource "checkpoint_gaiacommandsetsnmpsession" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args GaiaCommandSetSnmpSessionArgs
    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 GaiaCommandSetSnmpSessionArgs
    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 GaiaCommandSetSnmpSessionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GaiaCommandSetSnmpSessionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GaiaCommandSetSnmpSessionArgs
    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 gaiaCommandSetSnmpSessionResource = new Checkpoint.GaiaCommandSetSnmpSession("gaiaCommandSetSnmpSessionResource", new()
{
    CommunityString = "string",
    Debug = false,
    GaiaCommandSetSnmpSessionId = "string",
    SessionTimeout = 0,
    V3Object = new Checkpoint.Inputs.GaiaCommandSetSnmpSessionV3ObjectArgs
    {
        Authentication = new Checkpoint.Inputs.GaiaCommandSetSnmpSessionV3ObjectAuthenticationArgs
        {
            Password = "string",
            Protocol = "string",
        },
        DataPrivacy = false,
        Name = "string",
    },
});

    example, err := checkpoint.NewGaiaCommandSetSnmpSession(ctx, "gaiaCommandSetSnmpSessionResource", &checkpoint.GaiaCommandSetSnmpSessionArgs{
	CommunityString:             pulumi.String("string"),
	Debug:                       pulumi.Bool(false),
	GaiaCommandSetSnmpSessionId: pulumi.String("string"),
	SessionTimeout:              pulumi.Float64(0),
	V3Object: &checkpoint.GaiaCommandSetSnmpSessionV3ObjectArgs{
		Authentication: &checkpoint.GaiaCommandSetSnmpSessionV3ObjectAuthenticationArgs{
			Password: pulumi.String("string"),
			Protocol: pulumi.String("string"),
		},
		DataPrivacy: pulumi.Bool(false),
		Name:        pulumi.String("string"),
	},
})

    resource "checkpoint_gaiacommandsetsnmpsession" "gaiaCommandSetSnmpSessionResource" {
  community_string                 = "string"
  debug                            = false
  gaia_command_set_snmp_session_id = "string"
  session_timeout                  = 0
  v3_object = {
    authentication = {
      password = "string"
      protocol = "string"
    }
    data_privacy = false
    name         = "string"
  }
}

    var gaiaCommandSetSnmpSessionResource = new GaiaCommandSetSnmpSession("gaiaCommandSetSnmpSessionResource", GaiaCommandSetSnmpSessionArgs.builder()
    .communityString("string")
    .debug(false)
    .gaiaCommandSetSnmpSessionId("string")
    .sessionTimeout(0.0)
    .v3Object(GaiaCommandSetSnmpSessionV3ObjectArgs.builder()
        .authentication(GaiaCommandSetSnmpSessionV3ObjectAuthenticationArgs.builder()
            .password("string")
            .protocol("string")
            .build())
        .dataPrivacy(false)
        .name("string")
        .build())
    .build());

    gaia_command_set_snmp_session_resource = checkpoint.GaiaCommandSetSnmpSession("gaiaCommandSetSnmpSessionResource",
    community_string="string",
    debug=False,
    gaia_command_set_snmp_session_id="string",
    session_timeout=float(0),
    v3_object={
        "authentication": {
            "password": "string",
            "protocol": "string",
        },
        "data_privacy": False,
        "name": "string",
    })

    const gaiaCommandSetSnmpSessionResource = new checkpoint.GaiaCommandSetSnmpSession("gaiaCommandSetSnmpSessionResource", {
    communityString: "string",
    debug: false,
    gaiaCommandSetSnmpSessionId: "string",
    sessionTimeout: 0,
    v3Object: {
        authentication: {
            password: "string",
            protocol: "string",
        },
        dataPrivacy: false,
        name: "string",
    },
});

    type: checkpoint:GaiaCommandSetSnmpSession
properties:
    communityString: string
    debug: false
    gaiaCommandSetSnmpSessionId: string
    sessionTimeout: 0
    v3Object:
        authentication:
            password: string
            protocol: string
        dataPrivacy: false
        name: string

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

    CommunityString string
    SNMP v2 community password. required for SNMP v1/v2
    Debug bool
    Enable debugging for this resource only.
    GaiaCommandSetSnmpSessionId string
    SessionTimeout double
    Session expiration timeout in seconds
    V3Object GaiaCommandSetSnmpSessionV3Object
    SNMPv3 USM (User-based Security Model) details required for SNMP v3 Preferred v3_object blocks are documented below.
    CommunityString string
    SNMP v2 community password. required for SNMP v1/v2
    Debug bool
    Enable debugging for this resource only.
    GaiaCommandSetSnmpSessionId string
    SessionTimeout float64
    Session expiration timeout in seconds
    V3Object GaiaCommandSetSnmpSessionV3ObjectArgs
    SNMPv3 USM (User-based Security Model) details required for SNMP v3 Preferred v3_object blocks are documented below.
    community_string string
    SNMP v2 community password. required for SNMP v1/v2
    debug bool
    Enable debugging for this resource only.
    gaia_command_set_snmp_session_id string
    session_timeout number
    Session expiration timeout in seconds
    v3_object object
    SNMPv3 USM (User-based Security Model) details required for SNMP v3 Preferred v3_object blocks are documented below.
    communityString String
    SNMP v2 community password. required for SNMP v1/v2
    debug Boolean
    Enable debugging for this resource only.
    gaiaCommandSetSnmpSessionId String
    sessionTimeout Double
    Session expiration timeout in seconds
    v3Object GaiaCommandSetSnmpSessionV3Object
    SNMPv3 USM (User-based Security Model) details required for SNMP v3 Preferred v3_object blocks are documented below.
    communityString string
    SNMP v2 community password. required for SNMP v1/v2
    debug boolean
    Enable debugging for this resource only.
    gaiaCommandSetSnmpSessionId string
    sessionTimeout number
    Session expiration timeout in seconds
    v3Object GaiaCommandSetSnmpSessionV3Object
    SNMPv3 USM (User-based Security Model) details required for SNMP v3 Preferred v3_object blocks are documented below.
    community_string str
    SNMP v2 community password. required for SNMP v1/v2
    debug bool
    Enable debugging for this resource only.
    gaia_command_set_snmp_session_id str
    session_timeout float
    Session expiration timeout in seconds
    v3_object GaiaCommandSetSnmpSessionV3ObjectArgs
    SNMPv3 USM (User-based Security Model) details required for SNMP v3 Preferred v3_object blocks are documented below.
    communityString String
    SNMP v2 community password. required for SNMP v1/v2
    debug Boolean
    Enable debugging for this resource only.
    gaiaCommandSetSnmpSessionId String
    sessionTimeout Number
    Session expiration timeout in seconds
    v3Object Property Map
    SNMPv3 USM (User-based Security Model) details required for SNMP v3 Preferred v3_object blocks are documented below.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    SnmpSid string
    N/A
    Id string
    The provider-assigned unique ID for this managed resource.
    SnmpSid string
    N/A
    id string
    The provider-assigned unique ID for this managed resource.
    snmp_sid string
    N/A
    id String
    The provider-assigned unique ID for this managed resource.
    snmpSid String
    N/A
    id string
    The provider-assigned unique ID for this managed resource.
    snmpSid string
    N/A
    id str
    The provider-assigned unique ID for this managed resource.
    snmp_sid str
    N/A
    id String
    The provider-assigned unique ID for this managed resource.
    snmpSid String
    N/A

    Look up Existing GaiaCommandSetSnmpSession Resource

    Get an existing GaiaCommandSetSnmpSession 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?: GaiaCommandSetSnmpSessionState, opts?: CustomResourceOptions): GaiaCommandSetSnmpSession
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        community_string: Optional[str] = None,
        debug: Optional[bool] = None,
        gaia_command_set_snmp_session_id: Optional[str] = None,
        session_timeout: Optional[float] = None,
        snmp_sid: Optional[str] = None,
        v3_object: Optional[GaiaCommandSetSnmpSessionV3ObjectArgs] = None) -> GaiaCommandSetSnmpSession
    func GetGaiaCommandSetSnmpSession(ctx *Context, name string, id IDInput, state *GaiaCommandSetSnmpSessionState, opts ...ResourceOption) (*GaiaCommandSetSnmpSession, error)
    public static GaiaCommandSetSnmpSession Get(string name, Input<string> id, GaiaCommandSetSnmpSessionState? state, CustomResourceOptions? opts = null)
    public static GaiaCommandSetSnmpSession get(String name, Output<String> id, GaiaCommandSetSnmpSessionState state, CustomResourceOptions options)
    resources:  _:    type: checkpoint:GaiaCommandSetSnmpSession    get:      id: ${id}
    import {
  to = checkpoint_gaiacommandsetsnmpsession.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:
    CommunityString string
    SNMP v2 community password. required for SNMP v1/v2
    Debug bool
    Enable debugging for this resource only.
    GaiaCommandSetSnmpSessionId string
    SessionTimeout double
    Session expiration timeout in seconds
    SnmpSid string
    N/A
    V3Object GaiaCommandSetSnmpSessionV3Object
    SNMPv3 USM (User-based Security Model) details required for SNMP v3 Preferred v3_object blocks are documented below.
    CommunityString string
    SNMP v2 community password. required for SNMP v1/v2
    Debug bool
    Enable debugging for this resource only.
    GaiaCommandSetSnmpSessionId string
    SessionTimeout float64
    Session expiration timeout in seconds
    SnmpSid string
    N/A
    V3Object GaiaCommandSetSnmpSessionV3ObjectArgs
    SNMPv3 USM (User-based Security Model) details required for SNMP v3 Preferred v3_object blocks are documented below.
    community_string string
    SNMP v2 community password. required for SNMP v1/v2
    debug bool
    Enable debugging for this resource only.
    gaia_command_set_snmp_session_id string
    session_timeout number
    Session expiration timeout in seconds
    snmp_sid string
    N/A
    v3_object object
    SNMPv3 USM (User-based Security Model) details required for SNMP v3 Preferred v3_object blocks are documented below.
    communityString String
    SNMP v2 community password. required for SNMP v1/v2
    debug Boolean
    Enable debugging for this resource only.
    gaiaCommandSetSnmpSessionId String
    sessionTimeout Double
    Session expiration timeout in seconds
    snmpSid String
    N/A
    v3Object GaiaCommandSetSnmpSessionV3Object
    SNMPv3 USM (User-based Security Model) details required for SNMP v3 Preferred v3_object blocks are documented below.
    communityString string
    SNMP v2 community password. required for SNMP v1/v2
    debug boolean
    Enable debugging for this resource only.
    gaiaCommandSetSnmpSessionId string
    sessionTimeout number
    Session expiration timeout in seconds
    snmpSid string
    N/A
    v3Object GaiaCommandSetSnmpSessionV3Object
    SNMPv3 USM (User-based Security Model) details required for SNMP v3 Preferred v3_object blocks are documented below.
    community_string str
    SNMP v2 community password. required for SNMP v1/v2
    debug bool
    Enable debugging for this resource only.
    gaia_command_set_snmp_session_id str
    session_timeout float
    Session expiration timeout in seconds
    snmp_sid str
    N/A
    v3_object GaiaCommandSetSnmpSessionV3ObjectArgs
    SNMPv3 USM (User-based Security Model) details required for SNMP v3 Preferred v3_object blocks are documented below.
    communityString String
    SNMP v2 community password. required for SNMP v1/v2
    debug Boolean
    Enable debugging for this resource only.
    gaiaCommandSetSnmpSessionId String
    sessionTimeout Number
    Session expiration timeout in seconds
    snmpSid String
    N/A
    v3Object Property Map
    SNMPv3 USM (User-based Security Model) details required for SNMP v3 Preferred v3_object blocks are documented below.

    Supporting Types

    GaiaCommandSetSnmpSessionV3Object, GaiaCommandSetSnmpSessionV3ObjectArgs

    Authentication GaiaCommandSetSnmpSessionV3ObjectAuthentication
    Authentication details authentication blocks are documented below.
    DataPrivacy bool
    Related to AutoPriv/AutnNoPriv in SecurityLevel in the RFC. True: AutoPriv False: AuthNoPriv
    Name string
    SNMPv3 USM user
    Authentication GaiaCommandSetSnmpSessionV3ObjectAuthentication
    Authentication details authentication blocks are documented below.
    DataPrivacy bool
    Related to AutoPriv/AutnNoPriv in SecurityLevel in the RFC. True: AutoPriv False: AuthNoPriv
    Name string
    SNMPv3 USM user
    authentication object
    Authentication details authentication blocks are documented below.
    data_privacy bool
    Related to AutoPriv/AutnNoPriv in SecurityLevel in the RFC. True: AutoPriv False: AuthNoPriv
    name string
    SNMPv3 USM user
    authentication GaiaCommandSetSnmpSessionV3ObjectAuthentication
    Authentication details authentication blocks are documented below.
    dataPrivacy Boolean
    Related to AutoPriv/AutnNoPriv in SecurityLevel in the RFC. True: AutoPriv False: AuthNoPriv
    name String
    SNMPv3 USM user
    authentication GaiaCommandSetSnmpSessionV3ObjectAuthentication
    Authentication details authentication blocks are documented below.
    dataPrivacy boolean
    Related to AutoPriv/AutnNoPriv in SecurityLevel in the RFC. True: AutoPriv False: AuthNoPriv
    name string
    SNMPv3 USM user
    authentication GaiaCommandSetSnmpSessionV3ObjectAuthentication
    Authentication details authentication blocks are documented below.
    data_privacy bool
    Related to AutoPriv/AutnNoPriv in SecurityLevel in the RFC. True: AutoPriv False: AuthNoPriv
    name str
    SNMPv3 USM user
    authentication Property Map
    Authentication details authentication blocks are documented below.
    dataPrivacy Boolean
    Related to AutoPriv/AutnNoPriv in SecurityLevel in the RFC. True: AutoPriv False: AuthNoPriv
    name String
    SNMPv3 USM user

    GaiaCommandSetSnmpSessionV3ObjectAuthentication, GaiaCommandSetSnmpSessionV3ObjectAuthenticationArgs

    Password string
    Authentication Password - (8 or more printable characters) Each SNMPv3 USM user must have an authentication pass phrase. This will be used by the SNMPv3 agent to verify the identity of the user before granting access.
    Protocol string
    Authentication protocol, MD5 and SHA1 are not supported starting from R81
    Password string
    Authentication Password - (8 or more printable characters) Each SNMPv3 USM user must have an authentication pass phrase. This will be used by the SNMPv3 agent to verify the identity of the user before granting access.
    Protocol string
    Authentication protocol, MD5 and SHA1 are not supported starting from R81
    password string
    Authentication Password - (8 or more printable characters) Each SNMPv3 USM user must have an authentication pass phrase. This will be used by the SNMPv3 agent to verify the identity of the user before granting access.
    protocol string
    Authentication protocol, MD5 and SHA1 are not supported starting from R81
    password String
    Authentication Password - (8 or more printable characters) Each SNMPv3 USM user must have an authentication pass phrase. This will be used by the SNMPv3 agent to verify the identity of the user before granting access.
    protocol String
    Authentication protocol, MD5 and SHA1 are not supported starting from R81
    password string
    Authentication Password - (8 or more printable characters) Each SNMPv3 USM user must have an authentication pass phrase. This will be used by the SNMPv3 agent to verify the identity of the user before granting access.
    protocol string
    Authentication protocol, MD5 and SHA1 are not supported starting from R81
    password str
    Authentication Password - (8 or more printable characters) Each SNMPv3 USM user must have an authentication pass phrase. This will be used by the SNMPv3 agent to verify the identity of the user before granting access.
    protocol str
    Authentication protocol, MD5 and SHA1 are not supported starting from R81
    password String
    Authentication Password - (8 or more printable characters) Each SNMPv3 USM user must have an authentication pass phrase. This will be used by the SNMPv3 agent to verify the identity of the user before granting access.
    protocol String
    Authentication protocol, MD5 and SHA1 are not supported starting from R81

    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