1. Packages
  2. Fortios
  3. API Docs
  4. system
  5. Sessionttl
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

fortios.system.Sessionttl

Explore with Pulumi AI

Configure global session TTL timers for this FortiGate.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as fortios from "@pulumiverse/fortios";

const trname = new fortios.system.Sessionttl("trname", {"default": "3600"});
Copy
import pulumi
import pulumiverse_fortios as fortios

trname = fortios.system.Sessionttl("trname", default="3600")
Copy
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.NewSessionttl(ctx, "trname", &system.SessionttlArgs{
			Default: pulumi.String("3600"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortios = Pulumiverse.Fortios;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortios.System.Sessionttl("trname", new()
    {
        Default = "3600",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.system.Sessionttl;
import com.pulumi.fortios.system.SessionttlArgs;
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 Sessionttl("trname", SessionttlArgs.builder()
            .default_("3600")
            .build());

    }
}
Copy
resources:
  trname:
    type: fortios:system:Sessionttl
    properties:
      default: '3600'
Copy

Create Sessionttl Resource

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

Constructor syntax

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

@overload
def Sessionttl(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               default: Optional[str] = None,
               dynamic_sort_subtable: Optional[str] = None,
               get_all_tables: Optional[str] = None,
               ports: Optional[Sequence[SessionttlPortArgs]] = None,
               vdomparam: Optional[str] = None)
func NewSessionttl(ctx *Context, name string, args *SessionttlArgs, opts ...ResourceOption) (*Sessionttl, error)
public Sessionttl(string name, SessionttlArgs? args = null, CustomResourceOptions? opts = null)
public Sessionttl(String name, SessionttlArgs args)
public Sessionttl(String name, SessionttlArgs args, CustomResourceOptions options)
type: fortios:system:Sessionttl
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args SessionttlArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args SessionttlArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args SessionttlArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args SessionttlArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SessionttlArgs
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 sessionttlResource = new Fortios.System.Sessionttl("sessionttlResource", new()
{
    Default = "string",
    DynamicSortSubtable = "string",
    GetAllTables = "string",
    Ports = new[]
    {
        new Fortios.System.Inputs.SessionttlPortArgs
        {
            EndPort = 0,
            Id = 0,
            Protocol = 0,
            RefreshDirection = "string",
            StartPort = 0,
            Timeout = "string",
        },
    },
    Vdomparam = "string",
});
Copy
example, err := system.NewSessionttl(ctx, "sessionttlResource", &system.SessionttlArgs{
	Default:             pulumi.String("string"),
	DynamicSortSubtable: pulumi.String("string"),
	GetAllTables:        pulumi.String("string"),
	Ports: system.SessionttlPortArray{
		&system.SessionttlPortArgs{
			EndPort:          pulumi.Int(0),
			Id:               pulumi.Int(0),
			Protocol:         pulumi.Int(0),
			RefreshDirection: pulumi.String("string"),
			StartPort:        pulumi.Int(0),
			Timeout:          pulumi.String("string"),
		},
	},
	Vdomparam: pulumi.String("string"),
})
Copy
var sessionttlResource = new Sessionttl("sessionttlResource", SessionttlArgs.builder()
    .default_("string")
    .dynamicSortSubtable("string")
    .getAllTables("string")
    .ports(SessionttlPortArgs.builder()
        .endPort(0)
        .id(0)
        .protocol(0)
        .refreshDirection("string")
        .startPort(0)
        .timeout("string")
        .build())
    .vdomparam("string")
    .build());
Copy
sessionttl_resource = fortios.system.Sessionttl("sessionttlResource",
    default="string",
    dynamic_sort_subtable="string",
    get_all_tables="string",
    ports=[{
        "end_port": 0,
        "id": 0,
        "protocol": 0,
        "refresh_direction": "string",
        "start_port": 0,
        "timeout": "string",
    }],
    vdomparam="string")
Copy
const sessionttlResource = new fortios.system.Sessionttl("sessionttlResource", {
    "default": "string",
    dynamicSortSubtable: "string",
    getAllTables: "string",
    ports: [{
        endPort: 0,
        id: 0,
        protocol: 0,
        refreshDirection: "string",
        startPort: 0,
        timeout: "string",
    }],
    vdomparam: "string",
});
Copy
type: fortios:system:Sessionttl
properties:
    default: string
    dynamicSortSubtable: string
    getAllTables: string
    ports:
        - endPort: 0
          id: 0
          protocol: 0
          refreshDirection: string
          startPort: 0
          timeout: string
    vdomparam: string
Copy

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

Default string
Default timeout.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
GetAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
Ports List<Pulumiverse.Fortios.System.Inputs.SessionttlPort>
Session TTL port. The structure of port block is documented below.
Vdomparam Changes to this property will trigger replacement. 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.
Default string
Default timeout.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
GetAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
Ports []SessionttlPortArgs
Session TTL port. The structure of port block is documented below.
Vdomparam Changes to this property will trigger replacement. 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.
default_ String
Default timeout.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
getAllTables String
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
ports List<SessionttlPort>
Session TTL port. The structure of port block is documented below.
vdomparam Changes to this property will trigger replacement. 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.
default string
Default timeout.
dynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
getAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
ports SessionttlPort[]
Session TTL port. The structure of port block is documented below.
vdomparam Changes to this property will trigger replacement. 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.
default str
Default timeout.
dynamic_sort_subtable str
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
get_all_tables str
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
ports Sequence[SessionttlPortArgs]
Session TTL port. The structure of port block is documented below.
vdomparam Changes to this property will trigger replacement. 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.
default String
Default timeout.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
getAllTables String
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
ports List<Property Map>
Session TTL port. The structure of port block is documented below.
vdomparam Changes to this property will trigger replacement. 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 Sessionttl 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 Sessionttl Resource

Get an existing Sessionttl 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?: SessionttlState, opts?: CustomResourceOptions): Sessionttl
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        default: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        ports: Optional[Sequence[SessionttlPortArgs]] = None,
        vdomparam: Optional[str] = None) -> Sessionttl
func GetSessionttl(ctx *Context, name string, id IDInput, state *SessionttlState, opts ...ResourceOption) (*Sessionttl, error)
public static Sessionttl Get(string name, Input<string> id, SessionttlState? state, CustomResourceOptions? opts = null)
public static Sessionttl get(String name, Output<String> id, SessionttlState state, CustomResourceOptions options)
resources:  _:    type: fortios:system:Sessionttl    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Default string
Default timeout.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
GetAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
Ports List<Pulumiverse.Fortios.System.Inputs.SessionttlPort>
Session TTL port. The structure of port block is documented below.
Vdomparam Changes to this property will trigger replacement. 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.
Default string
Default timeout.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
GetAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
Ports []SessionttlPortArgs
Session TTL port. The structure of port block is documented below.
Vdomparam Changes to this property will trigger replacement. 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.
default_ String
Default timeout.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
getAllTables String
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
ports List<SessionttlPort>
Session TTL port. The structure of port block is documented below.
vdomparam Changes to this property will trigger replacement. 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.
default string
Default timeout.
dynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
getAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
ports SessionttlPort[]
Session TTL port. The structure of port block is documented below.
vdomparam Changes to this property will trigger replacement. 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.
default str
Default timeout.
dynamic_sort_subtable str
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
get_all_tables str
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
ports Sequence[SessionttlPortArgs]
Session TTL port. The structure of port block is documented below.
vdomparam Changes to this property will trigger replacement. 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.
default String
Default timeout.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
getAllTables String
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
ports List<Property Map>
Session TTL port. The structure of port block is documented below.
vdomparam Changes to this property will trigger replacement. 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.

Supporting Types

SessionttlPort
, SessionttlPortArgs

EndPort int
End port number.
Id int
Table entry ID.
Protocol int
Protocol (0 - 255).
RefreshDirection string
Refresh direction: Both, outgoing, incoming Valid values: both, outgoing, incoming.
StartPort int
Start port number.
Timeout string
Session timeout (TTL).
EndPort int
End port number.
Id int
Table entry ID.
Protocol int
Protocol (0 - 255).
RefreshDirection string
Refresh direction: Both, outgoing, incoming Valid values: both, outgoing, incoming.
StartPort int
Start port number.
Timeout string
Session timeout (TTL).
endPort Integer
End port number.
id Integer
Table entry ID.
protocol Integer
Protocol (0 - 255).
refreshDirection String
Refresh direction: Both, outgoing, incoming Valid values: both, outgoing, incoming.
startPort Integer
Start port number.
timeout String
Session timeout (TTL).
endPort number
End port number.
id number
Table entry ID.
protocol number
Protocol (0 - 255).
refreshDirection string
Refresh direction: Both, outgoing, incoming Valid values: both, outgoing, incoming.
startPort number
Start port number.
timeout string
Session timeout (TTL).
end_port int
End port number.
id int
Table entry ID.
protocol int
Protocol (0 - 255).
refresh_direction str
Refresh direction: Both, outgoing, incoming Valid values: both, outgoing, incoming.
start_port int
Start port number.
timeout str
Session timeout (TTL).
endPort Number
End port number.
id Number
Table entry ID.
protocol Number
Protocol (0 - 255).
refreshDirection String
Refresh direction: Both, outgoing, incoming Valid values: both, outgoing, incoming.
startPort Number
Start port number.
timeout String
Session timeout (TTL).

Import

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

$ pulumi import fortios:system/sessionttl:Sessionttl labelname SystemSessionTtl
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:system/sessionttl:Sessionttl labelname SystemSessionTtl
Copy

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