1. Registry
  2. Packages
  3. Fortimanager Provider
  4. API Docs
  5. ObjectFirewallProfileprotocoloptionsWebsocket
Viewing docs for fortimanager 1.18.0
published on Friday, Jul 31, 2026 by fortinetdev
Viewing docs for fortimanager 1.18.0
published on Friday, Jul 31, 2026 by fortinetdev

    Configure WebSocket protocol options.

    This resource is a sub resource for variable websocket of resource fortimanager.ObjectFirewallProfileprotocoloptions. Conflict and overwrite may occur if use both of them.

    Create ObjectFirewallProfileprotocoloptionsWebsocket Resource

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

    Constructor syntax

    new ObjectFirewallProfileprotocoloptionsWebsocket(name: string, args: ObjectFirewallProfileprotocoloptionsWebsocketArgs, opts?: CustomResourceOptions);
    @overload
    def ObjectFirewallProfileprotocoloptionsWebsocket(resource_name: str,
                                                      args: ObjectFirewallProfileprotocoloptionsWebsocketInitArgs,
                                                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def ObjectFirewallProfileprotocoloptionsWebsocket(resource_name: str,
                                                      opts: Optional[ResourceOptions] = None,
                                                      profile_protocol_options: Optional[str] = None,
                                                      scopetype: Optional[str] = None,
                                                      stream_based_uncompressed_limit: Optional[float] = None,
                                                      object_firewall_profileprotocoloptions_websocket_id: Optional[str] = None,
                                                      options: Optional[Sequence[str]] = None,
                                                      oversize_limit: Optional[float] = None,
                                                      comfort_amount: Optional[float] = None,
                                                      scan_bzip2: Optional[str] = None,
                                                      adom: Optional[str] = None,
                                                      comfort_interval: Optional[float] = None,
                                                      tcp_window_maximum: Optional[float] = None,
                                                      status: Optional[str] = None,
                                                      tcp_window_minimum: Optional[float] = None,
                                                      tcp_window_size: Optional[float] = None,
                                                      tcp_window_type: Optional[str] = None,
                                                      tunnel_non_websocket: Optional[str] = None,
                                                      uncompressed_nest_limit: Optional[float] = None,
                                                      uncompressed_oversize_limit: Optional[float] = None)
    func NewObjectFirewallProfileprotocoloptionsWebsocket(ctx *Context, name string, args ObjectFirewallProfileprotocoloptionsWebsocketArgs, opts ...ResourceOption) (*ObjectFirewallProfileprotocoloptionsWebsocket, error)
    public ObjectFirewallProfileprotocoloptionsWebsocket(string name, ObjectFirewallProfileprotocoloptionsWebsocketArgs args, CustomResourceOptions? opts = null)
    public ObjectFirewallProfileprotocoloptionsWebsocket(String name, ObjectFirewallProfileprotocoloptionsWebsocketArgs args)
    public ObjectFirewallProfileprotocoloptionsWebsocket(String name, ObjectFirewallProfileprotocoloptionsWebsocketArgs args, CustomResourceOptions options)
    
    type: fortimanager:ObjectFirewallProfileprotocoloptionsWebsocket
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "fortimanager_object_firewall_profileprotocoloptions_websocket" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args ObjectFirewallProfileprotocoloptionsWebsocketArgs
    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 ObjectFirewallProfileprotocoloptionsWebsocketInitArgs
    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 ObjectFirewallProfileprotocoloptionsWebsocketArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ObjectFirewallProfileprotocoloptionsWebsocketArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ObjectFirewallProfileprotocoloptionsWebsocketArgs
    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 objectFirewallProfileprotocoloptionsWebsocketResource = new Fortimanager.ObjectFirewallProfileprotocoloptionsWebsocket("objectFirewallProfileprotocoloptionsWebsocketResource", new()
    {
        ProfileProtocolOptions = "string",
        Scopetype = "string",
        StreamBasedUncompressedLimit = 0,
        ObjectFirewallProfileprotocoloptionsWebsocketId = "string",
        Options = new[]
        {
            "string",
        },
        OversizeLimit = 0,
        ComfortAmount = 0,
        ScanBzip2 = "string",
        Adom = "string",
        ComfortInterval = 0,
        TcpWindowMaximum = 0,
        Status = "string",
        TcpWindowMinimum = 0,
        TcpWindowSize = 0,
        TcpWindowType = "string",
        TunnelNonWebsocket = "string",
        UncompressedNestLimit = 0,
        UncompressedOversizeLimit = 0,
    });
    
    example, err := fortimanager.NewObjectFirewallProfileprotocoloptionsWebsocket(ctx, "objectFirewallProfileprotocoloptionsWebsocketResource", &fortimanager.ObjectFirewallProfileprotocoloptionsWebsocketArgs{
    	ProfileProtocolOptions:       pulumi.String("string"),
    	Scopetype:                    pulumi.String("string"),
    	StreamBasedUncompressedLimit: pulumi.Float64(0),
    	ObjectFirewallProfileprotocoloptionsWebsocketId: pulumi.String("string"),
    	Options: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	OversizeLimit:             pulumi.Float64(0),
    	ComfortAmount:             pulumi.Float64(0),
    	ScanBzip2:                 pulumi.String("string"),
    	Adom:                      pulumi.String("string"),
    	ComfortInterval:           pulumi.Float64(0),
    	TcpWindowMaximum:          pulumi.Float64(0),
    	Status:                    pulumi.String("string"),
    	TcpWindowMinimum:          pulumi.Float64(0),
    	TcpWindowSize:             pulumi.Float64(0),
    	TcpWindowType:             pulumi.String("string"),
    	TunnelNonWebsocket:        pulumi.String("string"),
    	UncompressedNestLimit:     pulumi.Float64(0),
    	UncompressedOversizeLimit: pulumi.Float64(0),
    })
    
    resource "fortimanager_object_firewall_profileprotocoloptions_websocket" "objectFirewallProfileprotocoloptionsWebsocketResource" {
      lifecycle {
        create_before_destroy = true
      }
      profile_protocol_options                            = "string"
      scopetype                                           = "string"
      stream_based_uncompressed_limit                     = 0
      object_firewall_profileprotocoloptions_websocket_id = "string"
      options                                             = ["string"]
      oversize_limit                                      = 0
      comfort_amount                                      = 0
      scan_bzip2                                          = "string"
      adom                                                = "string"
      comfort_interval                                    = 0
      tcp_window_maximum                                  = 0
      status                                              = "string"
      tcp_window_minimum                                  = 0
      tcp_window_size                                     = 0
      tcp_window_type                                     = "string"
      tunnel_non_websocket                                = "string"
      uncompressed_nest_limit                             = 0
      uncompressed_oversize_limit                         = 0
    }
    
    var objectFirewallProfileprotocoloptionsWebsocketResource = new ObjectFirewallProfileprotocoloptionsWebsocket("objectFirewallProfileprotocoloptionsWebsocketResource", ObjectFirewallProfileprotocoloptionsWebsocketArgs.builder()
        .profileProtocolOptions("string")
        .scopetype("string")
        .streamBasedUncompressedLimit(0.0)
        .objectFirewallProfileprotocoloptionsWebsocketId("string")
        .options("string")
        .oversizeLimit(0.0)
        .comfortAmount(0.0)
        .scanBzip2("string")
        .adom("string")
        .comfortInterval(0.0)
        .tcpWindowMaximum(0.0)
        .status("string")
        .tcpWindowMinimum(0.0)
        .tcpWindowSize(0.0)
        .tcpWindowType("string")
        .tunnelNonWebsocket("string")
        .uncompressedNestLimit(0.0)
        .uncompressedOversizeLimit(0.0)
        .build());
    
    object_firewall_profileprotocoloptions_websocket_resource = fortimanager.ObjectFirewallProfileprotocoloptionsWebsocket("objectFirewallProfileprotocoloptionsWebsocketResource",
        profile_protocol_options="string",
        scopetype="string",
        stream_based_uncompressed_limit=float(0),
        object_firewall_profileprotocoloptions_websocket_id="string",
        options=["string"],
        oversize_limit=float(0),
        comfort_amount=float(0),
        scan_bzip2="string",
        adom="string",
        comfort_interval=float(0),
        tcp_window_maximum=float(0),
        status="string",
        tcp_window_minimum=float(0),
        tcp_window_size=float(0),
        tcp_window_type="string",
        tunnel_non_websocket="string",
        uncompressed_nest_limit=float(0),
        uncompressed_oversize_limit=float(0))
    
    const objectFirewallProfileprotocoloptionsWebsocketResource = new fortimanager.ObjectFirewallProfileprotocoloptionsWebsocket("objectFirewallProfileprotocoloptionsWebsocketResource", {
        profileProtocolOptions: "string",
        scopetype: "string",
        streamBasedUncompressedLimit: 0,
        objectFirewallProfileprotocoloptionsWebsocketId: "string",
        options: ["string"],
        oversizeLimit: 0,
        comfortAmount: 0,
        scanBzip2: "string",
        adom: "string",
        comfortInterval: 0,
        tcpWindowMaximum: 0,
        status: "string",
        tcpWindowMinimum: 0,
        tcpWindowSize: 0,
        tcpWindowType: "string",
        tunnelNonWebsocket: "string",
        uncompressedNestLimit: 0,
        uncompressedOversizeLimit: 0,
    });
    
    type: fortimanager:ObjectFirewallProfileprotocoloptionsWebsocket
    properties:
        adom: string
        comfortAmount: 0
        comfortInterval: 0
        objectFirewallProfileprotocoloptionsWebsocketId: string
        options:
            - string
        oversizeLimit: 0
        profileProtocolOptions: string
        scanBzip2: string
        scopetype: string
        status: string
        streamBasedUncompressedLimit: 0
        tcpWindowMaximum: 0
        tcpWindowMinimum: 0
        tcpWindowSize: 0
        tcpWindowType: string
        tunnelNonWebsocket: string
        uncompressedNestLimit: 0
        uncompressedOversizeLimit: 0
    

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

    ProfileProtocolOptions string
    Profile Protocol Options.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    ComfortAmount double
    Number of bytes to send in each transmission for client comforting (bytes).
    ComfortInterval double
    Interval between successive transmissions of data for client comforting (seconds).
    ObjectFirewallProfileprotocoloptionsWebsocketId string
    an identifier for the resource.
    Options List<string>
    One or more options that can be applied to the session. Valid values: oversize, clientcomfort, servercomfort.
    OversizeLimit double
    Maximum in-memory file size that can be scanned (MB).
    ScanBzip2 string
    Enable/disable scanning of BZip2 compressed files. Valid values: disable, enable.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Status string
    Enable/disable the active status of scanning for this protocol. Valid values: disable, enable.
    StreamBasedUncompressedLimit double
    Maximum stream-based uncompressed data size that will be scanned in megabytes. Stream-based uncompression used only under certain conditions (unlimited = 0, default = 0).
    TcpWindowMaximum double
    Maximum dynamic TCP window size.
    TcpWindowMinimum double
    Minimum dynamic TCP window size.
    TcpWindowSize double
    Set TCP static window size.
    TcpWindowType string
    TCP window type to use for this protocol. Valid values: system, static, dynamic, auto-tuning.
    TunnelNonWebsocket string
    Configure how to process non-websocket traffic when a profile configured for websocket traffic accepts a non-websocket session. Valid values: disable, enable.
    UncompressedNestLimit double
    Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12).
    UncompressedOversizeLimit double
    Maximum in-memory uncompressed file size that can be scanned (MB).
    ProfileProtocolOptions string
    Profile Protocol Options.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    ComfortAmount float64
    Number of bytes to send in each transmission for client comforting (bytes).
    ComfortInterval float64
    Interval between successive transmissions of data for client comforting (seconds).
    ObjectFirewallProfileprotocoloptionsWebsocketId string
    an identifier for the resource.
    Options []string
    One or more options that can be applied to the session. Valid values: oversize, clientcomfort, servercomfort.
    OversizeLimit float64
    Maximum in-memory file size that can be scanned (MB).
    ScanBzip2 string
    Enable/disable scanning of BZip2 compressed files. Valid values: disable, enable.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Status string
    Enable/disable the active status of scanning for this protocol. Valid values: disable, enable.
    StreamBasedUncompressedLimit float64
    Maximum stream-based uncompressed data size that will be scanned in megabytes. Stream-based uncompression used only under certain conditions (unlimited = 0, default = 0).
    TcpWindowMaximum float64
    Maximum dynamic TCP window size.
    TcpWindowMinimum float64
    Minimum dynamic TCP window size.
    TcpWindowSize float64
    Set TCP static window size.
    TcpWindowType string
    TCP window type to use for this protocol. Valid values: system, static, dynamic, auto-tuning.
    TunnelNonWebsocket string
    Configure how to process non-websocket traffic when a profile configured for websocket traffic accepts a non-websocket session. Valid values: disable, enable.
    UncompressedNestLimit float64
    Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12).
    UncompressedOversizeLimit float64
    Maximum in-memory uncompressed file size that can be scanned (MB).
    profile_protocol_options string
    Profile Protocol Options.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comfort_amount number
    Number of bytes to send in each transmission for client comforting (bytes).
    comfort_interval number
    Interval between successive transmissions of data for client comforting (seconds).
    object_firewall_profileprotocoloptions_websocket_id string
    an identifier for the resource.
    options list(string)
    One or more options that can be applied to the session. Valid values: oversize, clientcomfort, servercomfort.
    oversize_limit number
    Maximum in-memory file size that can be scanned (MB).
    scan_bzip2 string
    Enable/disable scanning of BZip2 compressed files. Valid values: disable, enable.
    scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    status string
    Enable/disable the active status of scanning for this protocol. Valid values: disable, enable.
    stream_based_uncompressed_limit number
    Maximum stream-based uncompressed data size that will be scanned in megabytes. Stream-based uncompression used only under certain conditions (unlimited = 0, default = 0).
    tcp_window_maximum number
    Maximum dynamic TCP window size.
    tcp_window_minimum number
    Minimum dynamic TCP window size.
    tcp_window_size number
    Set TCP static window size.
    tcp_window_type string
    TCP window type to use for this protocol. Valid values: system, static, dynamic, auto-tuning.
    tunnel_non_websocket string
    Configure how to process non-websocket traffic when a profile configured for websocket traffic accepts a non-websocket session. Valid values: disable, enable.
    uncompressed_nest_limit number
    Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12).
    uncompressed_oversize_limit number
    Maximum in-memory uncompressed file size that can be scanned (MB).
    profileProtocolOptions String
    Profile Protocol Options.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comfortAmount Double
    Number of bytes to send in each transmission for client comforting (bytes).
    comfortInterval Double
    Interval between successive transmissions of data for client comforting (seconds).
    objectFirewallProfileprotocoloptionsWebsocketId String
    an identifier for the resource.
    options List<String>
    One or more options that can be applied to the session. Valid values: oversize, clientcomfort, servercomfort.
    oversizeLimit Double
    Maximum in-memory file size that can be scanned (MB).
    scanBzip2 String
    Enable/disable scanning of BZip2 compressed files. Valid values: disable, enable.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    status String
    Enable/disable the active status of scanning for this protocol. Valid values: disable, enable.
    streamBasedUncompressedLimit Double
    Maximum stream-based uncompressed data size that will be scanned in megabytes. Stream-based uncompression used only under certain conditions (unlimited = 0, default = 0).
    tcpWindowMaximum Double
    Maximum dynamic TCP window size.
    tcpWindowMinimum Double
    Minimum dynamic TCP window size.
    tcpWindowSize Double
    Set TCP static window size.
    tcpWindowType String
    TCP window type to use for this protocol. Valid values: system, static, dynamic, auto-tuning.
    tunnelNonWebsocket String
    Configure how to process non-websocket traffic when a profile configured for websocket traffic accepts a non-websocket session. Valid values: disable, enable.
    uncompressedNestLimit Double
    Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12).
    uncompressedOversizeLimit Double
    Maximum in-memory uncompressed file size that can be scanned (MB).
    profileProtocolOptions string
    Profile Protocol Options.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comfortAmount number
    Number of bytes to send in each transmission for client comforting (bytes).
    comfortInterval number
    Interval between successive transmissions of data for client comforting (seconds).
    objectFirewallProfileprotocoloptionsWebsocketId string
    an identifier for the resource.
    options string[]
    One or more options that can be applied to the session. Valid values: oversize, clientcomfort, servercomfort.
    oversizeLimit number
    Maximum in-memory file size that can be scanned (MB).
    scanBzip2 string
    Enable/disable scanning of BZip2 compressed files. Valid values: disable, enable.
    scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    status string
    Enable/disable the active status of scanning for this protocol. Valid values: disable, enable.
    streamBasedUncompressedLimit number
    Maximum stream-based uncompressed data size that will be scanned in megabytes. Stream-based uncompression used only under certain conditions (unlimited = 0, default = 0).
    tcpWindowMaximum number
    Maximum dynamic TCP window size.
    tcpWindowMinimum number
    Minimum dynamic TCP window size.
    tcpWindowSize number
    Set TCP static window size.
    tcpWindowType string
    TCP window type to use for this protocol. Valid values: system, static, dynamic, auto-tuning.
    tunnelNonWebsocket string
    Configure how to process non-websocket traffic when a profile configured for websocket traffic accepts a non-websocket session. Valid values: disable, enable.
    uncompressedNestLimit number
    Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12).
    uncompressedOversizeLimit number
    Maximum in-memory uncompressed file size that can be scanned (MB).
    profile_protocol_options str
    Profile Protocol Options.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comfort_amount float
    Number of bytes to send in each transmission for client comforting (bytes).
    comfort_interval float
    Interval between successive transmissions of data for client comforting (seconds).
    object_firewall_profileprotocoloptions_websocket_id str
    an identifier for the resource.
    options Sequence[str]
    One or more options that can be applied to the session. Valid values: oversize, clientcomfort, servercomfort.
    oversize_limit float
    Maximum in-memory file size that can be scanned (MB).
    scan_bzip2 str
    Enable/disable scanning of BZip2 compressed files. Valid values: disable, enable.
    scopetype str
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    status str
    Enable/disable the active status of scanning for this protocol. Valid values: disable, enable.
    stream_based_uncompressed_limit float
    Maximum stream-based uncompressed data size that will be scanned in megabytes. Stream-based uncompression used only under certain conditions (unlimited = 0, default = 0).
    tcp_window_maximum float
    Maximum dynamic TCP window size.
    tcp_window_minimum float
    Minimum dynamic TCP window size.
    tcp_window_size float
    Set TCP static window size.
    tcp_window_type str
    TCP window type to use for this protocol. Valid values: system, static, dynamic, auto-tuning.
    tunnel_non_websocket str
    Configure how to process non-websocket traffic when a profile configured for websocket traffic accepts a non-websocket session. Valid values: disable, enable.
    uncompressed_nest_limit float
    Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12).
    uncompressed_oversize_limit float
    Maximum in-memory uncompressed file size that can be scanned (MB).
    profileProtocolOptions String
    Profile Protocol Options.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comfortAmount Number
    Number of bytes to send in each transmission for client comforting (bytes).
    comfortInterval Number
    Interval between successive transmissions of data for client comforting (seconds).
    objectFirewallProfileprotocoloptionsWebsocketId String
    an identifier for the resource.
    options List<String>
    One or more options that can be applied to the session. Valid values: oversize, clientcomfort, servercomfort.
    oversizeLimit Number
    Maximum in-memory file size that can be scanned (MB).
    scanBzip2 String
    Enable/disable scanning of BZip2 compressed files. Valid values: disable, enable.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    status String
    Enable/disable the active status of scanning for this protocol. Valid values: disable, enable.
    streamBasedUncompressedLimit Number
    Maximum stream-based uncompressed data size that will be scanned in megabytes. Stream-based uncompression used only under certain conditions (unlimited = 0, default = 0).
    tcpWindowMaximum Number
    Maximum dynamic TCP window size.
    tcpWindowMinimum Number
    Minimum dynamic TCP window size.
    tcpWindowSize Number
    Set TCP static window size.
    tcpWindowType String
    TCP window type to use for this protocol. Valid values: system, static, dynamic, auto-tuning.
    tunnelNonWebsocket String
    Configure how to process non-websocket traffic when a profile configured for websocket traffic accepts a non-websocket session. Valid values: disable, enable.
    uncompressedNestLimit Number
    Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12).
    uncompressedOversizeLimit Number
    Maximum in-memory uncompressed file size that can be scanned (MB).

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ObjectFirewallProfileprotocoloptionsWebsocket 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 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 ObjectFirewallProfileprotocoloptionsWebsocket Resource

    Get an existing ObjectFirewallProfileprotocoloptionsWebsocket 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?: ObjectFirewallProfileprotocoloptionsWebsocketState, opts?: CustomResourceOptions): ObjectFirewallProfileprotocoloptionsWebsocket
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            adom: Optional[str] = None,
            comfort_amount: Optional[float] = None,
            comfort_interval: Optional[float] = None,
            object_firewall_profileprotocoloptions_websocket_id: Optional[str] = None,
            options: Optional[Sequence[str]] = None,
            oversize_limit: Optional[float] = None,
            profile_protocol_options: Optional[str] = None,
            scan_bzip2: Optional[str] = None,
            scopetype: Optional[str] = None,
            status: Optional[str] = None,
            stream_based_uncompressed_limit: Optional[float] = None,
            tcp_window_maximum: Optional[float] = None,
            tcp_window_minimum: Optional[float] = None,
            tcp_window_size: Optional[float] = None,
            tcp_window_type: Optional[str] = None,
            tunnel_non_websocket: Optional[str] = None,
            uncompressed_nest_limit: Optional[float] = None,
            uncompressed_oversize_limit: Optional[float] = None) -> ObjectFirewallProfileprotocoloptionsWebsocket
    func GetObjectFirewallProfileprotocoloptionsWebsocket(ctx *Context, name string, id IDInput, state *ObjectFirewallProfileprotocoloptionsWebsocketState, opts ...ResourceOption) (*ObjectFirewallProfileprotocoloptionsWebsocket, error)
    public static ObjectFirewallProfileprotocoloptionsWebsocket Get(string name, Input<string> id, ObjectFirewallProfileprotocoloptionsWebsocketState? state, CustomResourceOptions? opts = null)
    public static ObjectFirewallProfileprotocoloptionsWebsocket get(String name, Output<String> id, ObjectFirewallProfileprotocoloptionsWebsocketState state, CustomResourceOptions options)
    resources:  _:    type: fortimanager:ObjectFirewallProfileprotocoloptionsWebsocket    get:      id: ${id}
    import {
      to = fortimanager_object_firewall_profileprotocoloptions_websocket.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:
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    ComfortAmount double
    Number of bytes to send in each transmission for client comforting (bytes).
    ComfortInterval double
    Interval between successive transmissions of data for client comforting (seconds).
    ObjectFirewallProfileprotocoloptionsWebsocketId string
    an identifier for the resource.
    Options List<string>
    One or more options that can be applied to the session. Valid values: oversize, clientcomfort, servercomfort.
    OversizeLimit double
    Maximum in-memory file size that can be scanned (MB).
    ProfileProtocolOptions string
    Profile Protocol Options.
    ScanBzip2 string
    Enable/disable scanning of BZip2 compressed files. Valid values: disable, enable.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Status string
    Enable/disable the active status of scanning for this protocol. Valid values: disable, enable.
    StreamBasedUncompressedLimit double
    Maximum stream-based uncompressed data size that will be scanned in megabytes. Stream-based uncompression used only under certain conditions (unlimited = 0, default = 0).
    TcpWindowMaximum double
    Maximum dynamic TCP window size.
    TcpWindowMinimum double
    Minimum dynamic TCP window size.
    TcpWindowSize double
    Set TCP static window size.
    TcpWindowType string
    TCP window type to use for this protocol. Valid values: system, static, dynamic, auto-tuning.
    TunnelNonWebsocket string
    Configure how to process non-websocket traffic when a profile configured for websocket traffic accepts a non-websocket session. Valid values: disable, enable.
    UncompressedNestLimit double
    Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12).
    UncompressedOversizeLimit double
    Maximum in-memory uncompressed file size that can be scanned (MB).
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    ComfortAmount float64
    Number of bytes to send in each transmission for client comforting (bytes).
    ComfortInterval float64
    Interval between successive transmissions of data for client comforting (seconds).
    ObjectFirewallProfileprotocoloptionsWebsocketId string
    an identifier for the resource.
    Options []string
    One or more options that can be applied to the session. Valid values: oversize, clientcomfort, servercomfort.
    OversizeLimit float64
    Maximum in-memory file size that can be scanned (MB).
    ProfileProtocolOptions string
    Profile Protocol Options.
    ScanBzip2 string
    Enable/disable scanning of BZip2 compressed files. Valid values: disable, enable.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Status string
    Enable/disable the active status of scanning for this protocol. Valid values: disable, enable.
    StreamBasedUncompressedLimit float64
    Maximum stream-based uncompressed data size that will be scanned in megabytes. Stream-based uncompression used only under certain conditions (unlimited = 0, default = 0).
    TcpWindowMaximum float64
    Maximum dynamic TCP window size.
    TcpWindowMinimum float64
    Minimum dynamic TCP window size.
    TcpWindowSize float64
    Set TCP static window size.
    TcpWindowType string
    TCP window type to use for this protocol. Valid values: system, static, dynamic, auto-tuning.
    TunnelNonWebsocket string
    Configure how to process non-websocket traffic when a profile configured for websocket traffic accepts a non-websocket session. Valid values: disable, enable.
    UncompressedNestLimit float64
    Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12).
    UncompressedOversizeLimit float64
    Maximum in-memory uncompressed file size that can be scanned (MB).
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comfort_amount number
    Number of bytes to send in each transmission for client comforting (bytes).
    comfort_interval number
    Interval between successive transmissions of data for client comforting (seconds).
    object_firewall_profileprotocoloptions_websocket_id string
    an identifier for the resource.
    options list(string)
    One or more options that can be applied to the session. Valid values: oversize, clientcomfort, servercomfort.
    oversize_limit number
    Maximum in-memory file size that can be scanned (MB).
    profile_protocol_options string
    Profile Protocol Options.
    scan_bzip2 string
    Enable/disable scanning of BZip2 compressed files. Valid values: disable, enable.
    scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    status string
    Enable/disable the active status of scanning for this protocol. Valid values: disable, enable.
    stream_based_uncompressed_limit number
    Maximum stream-based uncompressed data size that will be scanned in megabytes. Stream-based uncompression used only under certain conditions (unlimited = 0, default = 0).
    tcp_window_maximum number
    Maximum dynamic TCP window size.
    tcp_window_minimum number
    Minimum dynamic TCP window size.
    tcp_window_size number
    Set TCP static window size.
    tcp_window_type string
    TCP window type to use for this protocol. Valid values: system, static, dynamic, auto-tuning.
    tunnel_non_websocket string
    Configure how to process non-websocket traffic when a profile configured for websocket traffic accepts a non-websocket session. Valid values: disable, enable.
    uncompressed_nest_limit number
    Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12).
    uncompressed_oversize_limit number
    Maximum in-memory uncompressed file size that can be scanned (MB).
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comfortAmount Double
    Number of bytes to send in each transmission for client comforting (bytes).
    comfortInterval Double
    Interval between successive transmissions of data for client comforting (seconds).
    objectFirewallProfileprotocoloptionsWebsocketId String
    an identifier for the resource.
    options List<String>
    One or more options that can be applied to the session. Valid values: oversize, clientcomfort, servercomfort.
    oversizeLimit Double
    Maximum in-memory file size that can be scanned (MB).
    profileProtocolOptions String
    Profile Protocol Options.
    scanBzip2 String
    Enable/disable scanning of BZip2 compressed files. Valid values: disable, enable.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    status String
    Enable/disable the active status of scanning for this protocol. Valid values: disable, enable.
    streamBasedUncompressedLimit Double
    Maximum stream-based uncompressed data size that will be scanned in megabytes. Stream-based uncompression used only under certain conditions (unlimited = 0, default = 0).
    tcpWindowMaximum Double
    Maximum dynamic TCP window size.
    tcpWindowMinimum Double
    Minimum dynamic TCP window size.
    tcpWindowSize Double
    Set TCP static window size.
    tcpWindowType String
    TCP window type to use for this protocol. Valid values: system, static, dynamic, auto-tuning.
    tunnelNonWebsocket String
    Configure how to process non-websocket traffic when a profile configured for websocket traffic accepts a non-websocket session. Valid values: disable, enable.
    uncompressedNestLimit Double
    Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12).
    uncompressedOversizeLimit Double
    Maximum in-memory uncompressed file size that can be scanned (MB).
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comfortAmount number
    Number of bytes to send in each transmission for client comforting (bytes).
    comfortInterval number
    Interval between successive transmissions of data for client comforting (seconds).
    objectFirewallProfileprotocoloptionsWebsocketId string
    an identifier for the resource.
    options string[]
    One or more options that can be applied to the session. Valid values: oversize, clientcomfort, servercomfort.
    oversizeLimit number
    Maximum in-memory file size that can be scanned (MB).
    profileProtocolOptions string
    Profile Protocol Options.
    scanBzip2 string
    Enable/disable scanning of BZip2 compressed files. Valid values: disable, enable.
    scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    status string
    Enable/disable the active status of scanning for this protocol. Valid values: disable, enable.
    streamBasedUncompressedLimit number
    Maximum stream-based uncompressed data size that will be scanned in megabytes. Stream-based uncompression used only under certain conditions (unlimited = 0, default = 0).
    tcpWindowMaximum number
    Maximum dynamic TCP window size.
    tcpWindowMinimum number
    Minimum dynamic TCP window size.
    tcpWindowSize number
    Set TCP static window size.
    tcpWindowType string
    TCP window type to use for this protocol. Valid values: system, static, dynamic, auto-tuning.
    tunnelNonWebsocket string
    Configure how to process non-websocket traffic when a profile configured for websocket traffic accepts a non-websocket session. Valid values: disable, enable.
    uncompressedNestLimit number
    Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12).
    uncompressedOversizeLimit number
    Maximum in-memory uncompressed file size that can be scanned (MB).
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comfort_amount float
    Number of bytes to send in each transmission for client comforting (bytes).
    comfort_interval float
    Interval between successive transmissions of data for client comforting (seconds).
    object_firewall_profileprotocoloptions_websocket_id str
    an identifier for the resource.
    options Sequence[str]
    One or more options that can be applied to the session. Valid values: oversize, clientcomfort, servercomfort.
    oversize_limit float
    Maximum in-memory file size that can be scanned (MB).
    profile_protocol_options str
    Profile Protocol Options.
    scan_bzip2 str
    Enable/disable scanning of BZip2 compressed files. Valid values: disable, enable.
    scopetype str
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    status str
    Enable/disable the active status of scanning for this protocol. Valid values: disable, enable.
    stream_based_uncompressed_limit float
    Maximum stream-based uncompressed data size that will be scanned in megabytes. Stream-based uncompression used only under certain conditions (unlimited = 0, default = 0).
    tcp_window_maximum float
    Maximum dynamic TCP window size.
    tcp_window_minimum float
    Minimum dynamic TCP window size.
    tcp_window_size float
    Set TCP static window size.
    tcp_window_type str
    TCP window type to use for this protocol. Valid values: system, static, dynamic, auto-tuning.
    tunnel_non_websocket str
    Configure how to process non-websocket traffic when a profile configured for websocket traffic accepts a non-websocket session. Valid values: disable, enable.
    uncompressed_nest_limit float
    Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12).
    uncompressed_oversize_limit float
    Maximum in-memory uncompressed file size that can be scanned (MB).
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comfortAmount Number
    Number of bytes to send in each transmission for client comforting (bytes).
    comfortInterval Number
    Interval between successive transmissions of data for client comforting (seconds).
    objectFirewallProfileprotocoloptionsWebsocketId String
    an identifier for the resource.
    options List<String>
    One or more options that can be applied to the session. Valid values: oversize, clientcomfort, servercomfort.
    oversizeLimit Number
    Maximum in-memory file size that can be scanned (MB).
    profileProtocolOptions String
    Profile Protocol Options.
    scanBzip2 String
    Enable/disable scanning of BZip2 compressed files. Valid values: disable, enable.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    status String
    Enable/disable the active status of scanning for this protocol. Valid values: disable, enable.
    streamBasedUncompressedLimit Number
    Maximum stream-based uncompressed data size that will be scanned in megabytes. Stream-based uncompression used only under certain conditions (unlimited = 0, default = 0).
    tcpWindowMaximum Number
    Maximum dynamic TCP window size.
    tcpWindowMinimum Number
    Minimum dynamic TCP window size.
    tcpWindowSize Number
    Set TCP static window size.
    tcpWindowType String
    TCP window type to use for this protocol. Valid values: system, static, dynamic, auto-tuning.
    tunnelNonWebsocket String
    Configure how to process non-websocket traffic when a profile configured for websocket traffic accepts a non-websocket session. Valid values: disable, enable.
    uncompressedNestLimit Number
    Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12).
    uncompressedOversizeLimit Number
    Maximum in-memory uncompressed file size that can be scanned (MB).

    Import

    ObjectFirewall ProfileProtocolOptionsWebsocket can be imported using any of these accepted formats:

    Set import_options = [“profile_protocol_options=YOUR_VALUE”] in the provider section.

    $ export “FORTIMANAGER_IMPORT_TABLE”=“true”

    $ pulumi import fortimanager:index/objectFirewallProfileprotocoloptionsWebsocket:ObjectFirewallProfileprotocoloptionsWebsocket labelname ObjectFirewallProfileProtocolOptionsWebsocket
    

    $ unset “FORTIMANAGER_IMPORT_TABLE”

    -> Hint: The scopetype and adom for import will directly inherit the scopetype and adom configuration of the provider.

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

    Package Details

    Repository
    fortimanager fortinetdev/terraform-provider-fortimanager
    License
    Notes
    This Pulumi package is based on the fortimanager Terraform Provider.
    Viewing docs for fortimanager 1.18.0
    published on Friday, Jul 31, 2026 by fortinetdev

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial