1. Packages
  2. Fortios
  3. API Docs
  4. system
  5. Sessionhelper
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

fortios.system.Sessionhelper

Explore with Pulumi AI

fortios logo
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

    Configure session helper.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as fortios from "@pulumiverse/fortios";
    
    const trname = new fortios.system.Sessionhelper("trname", {
        fosid: 33,
        port: 3234,
        protocol: 17,
    });
    
    import pulumi
    import pulumiverse_fortios as fortios
    
    trname = fortios.system.Sessionhelper("trname",
        fosid=33,
        port=3234,
        protocol=17)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-fortios/sdk/go/fortios/system"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := system.NewSessionhelper(ctx, "trname", &system.SessionhelperArgs{
    			Fosid:    pulumi.Int(33),
    			Port:     pulumi.Int(3234),
    			Protocol: pulumi.Int(17),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Fortios = Pulumiverse.Fortios;
    
    return await Deployment.RunAsync(() => 
    {
        var trname = new Fortios.System.Sessionhelper("trname", new()
        {
            Fosid = 33,
            Port = 3234,
            Protocol = 17,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.fortios.system.Sessionhelper;
    import com.pulumi.fortios.system.SessionhelperArgs;
    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 trname = new Sessionhelper("trname", SessionhelperArgs.builder()        
                .fosid(33)
                .port(3234)
                .protocol(17)
                .build());
    
        }
    }
    
    resources:
      trname:
        type: fortios:system:Sessionhelper
        properties:
          fosid: 33
          port: 3234
          protocol: 17
    

    Create Sessionhelper Resource

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

    Constructor syntax

    new Sessionhelper(name: string, args: SessionhelperArgs, opts?: CustomResourceOptions);
    @overload
    def Sessionhelper(resource_name: str,
                      args: SessionhelperArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def Sessionhelper(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      port: Optional[int] = None,
                      protocol: Optional[int] = None,
                      fosid: Optional[int] = None,
                      name: Optional[str] = None,
                      vdomparam: Optional[str] = None)
    func NewSessionhelper(ctx *Context, name string, args SessionhelperArgs, opts ...ResourceOption) (*Sessionhelper, error)
    public Sessionhelper(string name, SessionhelperArgs args, CustomResourceOptions? opts = null)
    public Sessionhelper(String name, SessionhelperArgs args)
    public Sessionhelper(String name, SessionhelperArgs args, CustomResourceOptions options)
    
    type: fortios:system:Sessionhelper
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args SessionhelperArgs
    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 SessionhelperArgs
    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 SessionhelperArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SessionhelperArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SessionhelperArgs
    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 sessionhelperResource = new Fortios.System.Sessionhelper("sessionhelperResource", new()
    {
        Port = 0,
        Protocol = 0,
        Fosid = 0,
        Name = "string",
        Vdomparam = "string",
    });
    
    example, err := system.NewSessionhelper(ctx, "sessionhelperResource", &system.SessionhelperArgs{
    	Port:      pulumi.Int(0),
    	Protocol:  pulumi.Int(0),
    	Fosid:     pulumi.Int(0),
    	Name:      pulumi.String("string"),
    	Vdomparam: pulumi.String("string"),
    })
    
    var sessionhelperResource = new Sessionhelper("sessionhelperResource", SessionhelperArgs.builder()
        .port(0)
        .protocol(0)
        .fosid(0)
        .name("string")
        .vdomparam("string")
        .build());
    
    sessionhelper_resource = fortios.system.Sessionhelper("sessionhelperResource",
        port=0,
        protocol=0,
        fosid=0,
        name="string",
        vdomparam="string")
    
    const sessionhelperResource = new fortios.system.Sessionhelper("sessionhelperResource", {
        port: 0,
        protocol: 0,
        fosid: 0,
        name: "string",
        vdomparam: "string",
    });
    
    type: fortios:system:Sessionhelper
    properties:
        fosid: 0
        name: string
        port: 0
        protocol: 0
        vdomparam: string
    

    Sessionhelper Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Sessionhelper resource accepts the following input properties:

    Port int
    Protocol port.
    Protocol int
    Protocol number.
    Fosid int
    Session helper ID.
    Name string
    Helper name.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    Port int
    Protocol port.
    Protocol int
    Protocol number.
    Fosid int
    Session helper ID.
    Name string
    Helper name.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    port Integer
    Protocol port.
    protocol Integer
    Protocol number.
    fosid Integer
    Session helper ID.
    name String
    Helper name.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    port number
    Protocol port.
    protocol number
    Protocol number.
    fosid number
    Session helper ID.
    name string
    Helper name.
    vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    port int
    Protocol port.
    protocol int
    Protocol number.
    fosid int
    Session helper ID.
    name str
    Helper name.
    vdomparam str
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    port Number
    Protocol port.
    protocol Number
    Protocol number.
    fosid Number
    Session helper ID.
    name String
    Helper name.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Sessionhelper Resource

    Get an existing Sessionhelper 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?: SessionhelperState, opts?: CustomResourceOptions): Sessionhelper
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            fosid: Optional[int] = None,
            name: Optional[str] = None,
            port: Optional[int] = None,
            protocol: Optional[int] = None,
            vdomparam: Optional[str] = None) -> Sessionhelper
    func GetSessionhelper(ctx *Context, name string, id IDInput, state *SessionhelperState, opts ...ResourceOption) (*Sessionhelper, error)
    public static Sessionhelper Get(string name, Input<string> id, SessionhelperState? state, CustomResourceOptions? opts = null)
    public static Sessionhelper get(String name, Output<String> id, SessionhelperState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Fosid int
    Session helper ID.
    Name string
    Helper name.
    Port int
    Protocol port.
    Protocol int
    Protocol number.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    Fosid int
    Session helper ID.
    Name string
    Helper name.
    Port int
    Protocol port.
    Protocol int
    Protocol number.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    fosid Integer
    Session helper ID.
    name String
    Helper name.
    port Integer
    Protocol port.
    protocol Integer
    Protocol number.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    fosid number
    Session helper ID.
    name string
    Helper name.
    port number
    Protocol port.
    protocol number
    Protocol number.
    vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    fosid int
    Session helper ID.
    name str
    Helper name.
    port int
    Protocol port.
    protocol int
    Protocol number.
    vdomparam str
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    fosid Number
    Session helper ID.
    name String
    Helper name.
    port Number
    Protocol port.
    protocol Number
    Protocol number.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

    Import

    System SessionHelper can be imported using any of these accepted formats:

    $ pulumi import fortios:system/sessionhelper:Sessionhelper labelname {{fosid}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:system/sessionhelper:Sessionhelper labelname {{fosid}}
    

    $ unset “FORTIOS_IMPORT_TABLE”

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    fortios pulumiverse/pulumi-fortios
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the fortios Terraform Provider.
    fortios logo
    Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse