Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. ObjectIcapProfile
fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

fortimanager.ObjectIcapProfile

Explore with Pulumi AI

fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

Configure ICAP profiles.

The following variables have sub resource. Avoid using them together, otherwise conflicts and overwrites may occur.

  • icap_headers: fortimanager.ObjectIcapProfileIcapheaders
  • respmod_forward_rules: fortimanager.ObjectIcapProfileRespmodforwardrules

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as fortimanager from "@pulumi/fortimanager";

const trname = new fortimanager.ObjectIcapProfile("trname", {
    methods: [
        "delete",
        "get",
        "head",
        "options",
        "other",
        "post",
        "put",
        "trace",
    ],
    preview: "disable",
    previewDataLength: 500,
    request: "disable",
    respmodDefaultAction: "forward",
    response: "disable",
    responseReqHdr: "disable",
    streamingContentBypass: "disable",
});
Copy
import pulumi
import pulumi_fortimanager as fortimanager

trname = fortimanager.ObjectIcapProfile("trname",
    methods=[
        "delete",
        "get",
        "head",
        "options",
        "other",
        "post",
        "put",
        "trace",
    ],
    preview="disable",
    preview_data_length=500,
    request="disable",
    respmod_default_action="forward",
    response="disable",
    response_req_hdr="disable",
    streaming_content_bypass="disable")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/fortimanager/fortimanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fortimanager.NewObjectIcapProfile(ctx, "trname", &fortimanager.ObjectIcapProfileArgs{
			Methods: pulumi.StringArray{
				pulumi.String("delete"),
				pulumi.String("get"),
				pulumi.String("head"),
				pulumi.String("options"),
				pulumi.String("other"),
				pulumi.String("post"),
				pulumi.String("put"),
				pulumi.String("trace"),
			},
			Preview:                pulumi.String("disable"),
			PreviewDataLength:      pulumi.Float64(500),
			Request:                pulumi.String("disable"),
			RespmodDefaultAction:   pulumi.String("forward"),
			Response:               pulumi.String("disable"),
			ResponseReqHdr:         pulumi.String("disable"),
			StreamingContentBypass: pulumi.String("disable"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortimanager = Pulumi.Fortimanager;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortimanager.ObjectIcapProfile("trname", new()
    {
        Methods = new[]
        {
            "delete",
            "get",
            "head",
            "options",
            "other",
            "post",
            "put",
            "trace",
        },
        Preview = "disable",
        PreviewDataLength = 500,
        Request = "disable",
        RespmodDefaultAction = "forward",
        Response = "disable",
        ResponseReqHdr = "disable",
        StreamingContentBypass = "disable",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortimanager.ObjectIcapProfile;
import com.pulumi.fortimanager.ObjectIcapProfileArgs;
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 ObjectIcapProfile("trname", ObjectIcapProfileArgs.builder()
            .methods(            
                "delete",
                "get",
                "head",
                "options",
                "other",
                "post",
                "put",
                "trace")
            .preview("disable")
            .previewDataLength(500)
            .request("disable")
            .respmodDefaultAction("forward")
            .response("disable")
            .responseReqHdr("disable")
            .streamingContentBypass("disable")
            .build());

    }
}
Copy
resources:
  trname:
    type: fortimanager:ObjectIcapProfile
    properties:
      methods:
        - delete
        - get
        - head
        - options
        - other
        - post
        - put
        - trace
      preview: disable
      previewDataLength: 500
      request: disable
      respmodDefaultAction: forward
      response: disable
      responseReqHdr: disable
      streamingContentBypass: disable
Copy

Create ObjectIcapProfile Resource

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

Constructor syntax

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

@overload
def ObjectIcapProfile(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      adom: Optional[str] = None,
                      chunk_encap: Optional[str] = None,
                      comment: Optional[str] = None,
                      dynamic_sort_subtable: Optional[str] = None,
                      extension_features: Optional[Sequence[str]] = None,
                      file_transfer_failure: Optional[str] = None,
                      file_transfer_path: Optional[str] = None,
                      file_transfer_server: Optional[str] = None,
                      file_transfers: Optional[Sequence[str]] = None,
                      icap_block_log: Optional[str] = None,
                      icap_headers: Optional[Sequence[ObjectIcapProfileIcapHeaderArgs]] = None,
                      methods: Optional[Sequence[str]] = None,
                      n204_response: Optional[str] = None,
                      n204_size_limit: Optional[float] = None,
                      name: Optional[str] = None,
                      object_icap_profile_id: Optional[str] = None,
                      preview: Optional[str] = None,
                      preview_data_length: Optional[float] = None,
                      replacemsg_group: Optional[str] = None,
                      request: Optional[str] = None,
                      request_failure: Optional[str] = None,
                      request_path: Optional[str] = None,
                      request_server: Optional[str] = None,
                      respmod_default_action: Optional[str] = None,
                      respmod_forward_rules: Optional[Sequence[ObjectIcapProfileRespmodForwardRuleArgs]] = None,
                      response: Optional[str] = None,
                      response_failure: Optional[str] = None,
                      response_path: Optional[str] = None,
                      response_req_hdr: Optional[str] = None,
                      response_server: Optional[str] = None,
                      scan_progress_interval: Optional[float] = None,
                      scopetype: Optional[str] = None,
                      streaming_content_bypass: Optional[str] = None,
                      timeout: Optional[float] = None)
func NewObjectIcapProfile(ctx *Context, name string, args *ObjectIcapProfileArgs, opts ...ResourceOption) (*ObjectIcapProfile, error)
public ObjectIcapProfile(string name, ObjectIcapProfileArgs? args = null, CustomResourceOptions? opts = null)
public ObjectIcapProfile(String name, ObjectIcapProfileArgs args)
public ObjectIcapProfile(String name, ObjectIcapProfileArgs args, CustomResourceOptions options)

type: fortimanager:ObjectIcapProfile
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 ObjectIcapProfileArgs
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 ObjectIcapProfileArgs
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 ObjectIcapProfileArgs
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 ObjectIcapProfileArgs
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. ObjectIcapProfileArgs
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 objectIcapProfileResource = new Fortimanager.ObjectIcapProfile("objectIcapProfileResource", new()
{
    Adom = "string",
    ChunkEncap = "string",
    Comment = "string",
    DynamicSortSubtable = "string",
    ExtensionFeatures = new[]
    {
        "string",
    },
    FileTransferFailure = "string",
    FileTransferPath = "string",
    FileTransferServer = "string",
    FileTransfers = new[]
    {
        "string",
    },
    IcapBlockLog = "string",
    IcapHeaders = new[]
    {
        new Fortimanager.Inputs.ObjectIcapProfileIcapHeaderArgs
        {
            Base64Encoding = "string",
            Content = "string",
            Id = 0,
            Name = "string",
        },
    },
    Methods = new[]
    {
        "string",
    },
    N204Response = "string",
    N204SizeLimit = 0,
    Name = "string",
    ObjectIcapProfileId = "string",
    Preview = "string",
    PreviewDataLength = 0,
    ReplacemsgGroup = "string",
    Request = "string",
    RequestFailure = "string",
    RequestPath = "string",
    RequestServer = "string",
    RespmodDefaultAction = "string",
    RespmodForwardRules = new[]
    {
        new Fortimanager.Inputs.ObjectIcapProfileRespmodForwardRuleArgs
        {
            Action = "string",
            HeaderGroups = new[]
            {
                new Fortimanager.Inputs.ObjectIcapProfileRespmodForwardRuleHeaderGroupArgs
                {
                    CaseSensitivity = "string",
                    Header = "string",
                    HeaderName = "string",
                    Id = 0,
                },
            },
            Host = "string",
            HttpRespStatusCodes = new[]
            {
                0,
            },
            Name = "string",
        },
    },
    Response = "string",
    ResponseFailure = "string",
    ResponsePath = "string",
    ResponseReqHdr = "string",
    ResponseServer = "string",
    ScanProgressInterval = 0,
    Scopetype = "string",
    StreamingContentBypass = "string",
    Timeout = 0,
});
Copy
example, err := fortimanager.NewObjectIcapProfile(ctx, "objectIcapProfileResource", &fortimanager.ObjectIcapProfileArgs{
Adom: pulumi.String("string"),
ChunkEncap: pulumi.String("string"),
Comment: pulumi.String("string"),
DynamicSortSubtable: pulumi.String("string"),
ExtensionFeatures: pulumi.StringArray{
pulumi.String("string"),
},
FileTransferFailure: pulumi.String("string"),
FileTransferPath: pulumi.String("string"),
FileTransferServer: pulumi.String("string"),
FileTransfers: pulumi.StringArray{
pulumi.String("string"),
},
IcapBlockLog: pulumi.String("string"),
IcapHeaders: .ObjectIcapProfileIcapHeaderArray{
&.ObjectIcapProfileIcapHeaderArgs{
Base64Encoding: pulumi.String("string"),
Content: pulumi.String("string"),
Id: pulumi.Float64(0),
Name: pulumi.String("string"),
},
},
Methods: pulumi.StringArray{
pulumi.String("string"),
},
N204Response: pulumi.String("string"),
N204SizeLimit: pulumi.Float64(0),
Name: pulumi.String("string"),
ObjectIcapProfileId: pulumi.String("string"),
Preview: pulumi.String("string"),
PreviewDataLength: pulumi.Float64(0),
ReplacemsgGroup: pulumi.String("string"),
Request: pulumi.String("string"),
RequestFailure: pulumi.String("string"),
RequestPath: pulumi.String("string"),
RequestServer: pulumi.String("string"),
RespmodDefaultAction: pulumi.String("string"),
RespmodForwardRules: .ObjectIcapProfileRespmodForwardRuleArray{
&.ObjectIcapProfileRespmodForwardRuleArgs{
Action: pulumi.String("string"),
HeaderGroups: .ObjectIcapProfileRespmodForwardRuleHeaderGroupArray{
&.ObjectIcapProfileRespmodForwardRuleHeaderGroupArgs{
CaseSensitivity: pulumi.String("string"),
Header: pulumi.String("string"),
HeaderName: pulumi.String("string"),
Id: pulumi.Float64(0),
},
},
Host: pulumi.String("string"),
HttpRespStatusCodes: pulumi.Float64Array{
pulumi.Float64(0),
},
Name: pulumi.String("string"),
},
},
Response: pulumi.String("string"),
ResponseFailure: pulumi.String("string"),
ResponsePath: pulumi.String("string"),
ResponseReqHdr: pulumi.String("string"),
ResponseServer: pulumi.String("string"),
ScanProgressInterval: pulumi.Float64(0),
Scopetype: pulumi.String("string"),
StreamingContentBypass: pulumi.String("string"),
Timeout: pulumi.Float64(0),
})
Copy
var objectIcapProfileResource = new ObjectIcapProfile("objectIcapProfileResource", ObjectIcapProfileArgs.builder()
    .adom("string")
    .chunkEncap("string")
    .comment("string")
    .dynamicSortSubtable("string")
    .extensionFeatures("string")
    .fileTransferFailure("string")
    .fileTransferPath("string")
    .fileTransferServer("string")
    .fileTransfers("string")
    .icapBlockLog("string")
    .icapHeaders(ObjectIcapProfileIcapHeaderArgs.builder()
        .base64Encoding("string")
        .content("string")
        .id(0)
        .name("string")
        .build())
    .methods("string")
    .n204Response("string")
    .n204SizeLimit(0)
    .name("string")
    .objectIcapProfileId("string")
    .preview("string")
    .previewDataLength(0)
    .replacemsgGroup("string")
    .request("string")
    .requestFailure("string")
    .requestPath("string")
    .requestServer("string")
    .respmodDefaultAction("string")
    .respmodForwardRules(ObjectIcapProfileRespmodForwardRuleArgs.builder()
        .action("string")
        .headerGroups(ObjectIcapProfileRespmodForwardRuleHeaderGroupArgs.builder()
            .caseSensitivity("string")
            .header("string")
            .headerName("string")
            .id(0)
            .build())
        .host("string")
        .httpRespStatusCodes(0)
        .name("string")
        .build())
    .response("string")
    .responseFailure("string")
    .responsePath("string")
    .responseReqHdr("string")
    .responseServer("string")
    .scanProgressInterval(0)
    .scopetype("string")
    .streamingContentBypass("string")
    .timeout(0)
    .build());
Copy
object_icap_profile_resource = fortimanager.ObjectIcapProfile("objectIcapProfileResource",
    adom="string",
    chunk_encap="string",
    comment="string",
    dynamic_sort_subtable="string",
    extension_features=["string"],
    file_transfer_failure="string",
    file_transfer_path="string",
    file_transfer_server="string",
    file_transfers=["string"],
    icap_block_log="string",
    icap_headers=[{
        "base64_encoding": "string",
        "content": "string",
        "id": 0,
        "name": "string",
    }],
    methods=["string"],
    n204_response="string",
    n204_size_limit=0,
    name="string",
    object_icap_profile_id="string",
    preview="string",
    preview_data_length=0,
    replacemsg_group="string",
    request="string",
    request_failure="string",
    request_path="string",
    request_server="string",
    respmod_default_action="string",
    respmod_forward_rules=[{
        "action": "string",
        "header_groups": [{
            "case_sensitivity": "string",
            "header": "string",
            "header_name": "string",
            "id": 0,
        }],
        "host": "string",
        "http_resp_status_codes": [0],
        "name": "string",
    }],
    response="string",
    response_failure="string",
    response_path="string",
    response_req_hdr="string",
    response_server="string",
    scan_progress_interval=0,
    scopetype="string",
    streaming_content_bypass="string",
    timeout=0)
Copy
const objectIcapProfileResource = new fortimanager.ObjectIcapProfile("objectIcapProfileResource", {
    adom: "string",
    chunkEncap: "string",
    comment: "string",
    dynamicSortSubtable: "string",
    extensionFeatures: ["string"],
    fileTransferFailure: "string",
    fileTransferPath: "string",
    fileTransferServer: "string",
    fileTransfers: ["string"],
    icapBlockLog: "string",
    icapHeaders: [{
        base64Encoding: "string",
        content: "string",
        id: 0,
        name: "string",
    }],
    methods: ["string"],
    n204Response: "string",
    n204SizeLimit: 0,
    name: "string",
    objectIcapProfileId: "string",
    preview: "string",
    previewDataLength: 0,
    replacemsgGroup: "string",
    request: "string",
    requestFailure: "string",
    requestPath: "string",
    requestServer: "string",
    respmodDefaultAction: "string",
    respmodForwardRules: [{
        action: "string",
        headerGroups: [{
            caseSensitivity: "string",
            header: "string",
            headerName: "string",
            id: 0,
        }],
        host: "string",
        httpRespStatusCodes: [0],
        name: "string",
    }],
    response: "string",
    responseFailure: "string",
    responsePath: "string",
    responseReqHdr: "string",
    responseServer: "string",
    scanProgressInterval: 0,
    scopetype: "string",
    streamingContentBypass: "string",
    timeout: 0,
});
Copy
type: fortimanager:ObjectIcapProfile
properties:
    adom: string
    chunkEncap: string
    comment: string
    dynamicSortSubtable: string
    extensionFeatures:
        - string
    fileTransferFailure: string
    fileTransferPath: string
    fileTransferServer: string
    fileTransfers:
        - string
    icapBlockLog: string
    icapHeaders:
        - base64Encoding: string
          content: string
          id: 0
          name: string
    methods:
        - string
    n204Response: string
    n204SizeLimit: 0
    name: string
    objectIcapProfileId: string
    preview: string
    previewDataLength: 0
    replacemsgGroup: string
    request: string
    requestFailure: string
    requestPath: string
    requestServer: string
    respmodDefaultAction: string
    respmodForwardRules:
        - action: string
          headerGroups:
            - caseSensitivity: string
              header: string
              headerName: string
              id: 0
          host: string
          httpRespStatusCodes:
            - 0
          name: string
    response: string
    responseFailure: string
    responsePath: string
    responseReqHdr: string
    responseServer: string
    scanProgressInterval: 0
    scopetype: string
    streamingContentBypass: string
    timeout: 0
Copy

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

Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
ChunkEncap string
Enable/disable chunked encapsulation (default = disable). Valid values: disable, enable.
Comment string
Comment.
DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
ExtensionFeatures List<string>
Enable/disable ICAP extension features. Valid values: scan-progress.
FileTransferFailure string
Action to take if the ICAP server cannot be contacted when processing a file transfer. Valid values: error, bypass.
FileTransferPath string
Path component of the ICAP URI that identifies the file transfer processing service.
FileTransferServer string
ICAP server to use for a file transfer.
FileTransfers List<string>
Configure the file transfer protocols to pass transferred files to an ICAP server as REQMOD. Valid values: ssh, ftp.
IcapBlockLog string
Enable/disable UTM log when infection found (default = disable). Valid values: disable, enable.
IcapHeaders List<ObjectIcapProfileIcapHeader>
Icap-Headers. The structure of icap_headers block is documented below.
Methods List<string>
The allowed HTTP methods that will be sent to ICAP server for further processing. Valid values: delete, get, head, options, post, put, trace, other.
N204Response string
Enable/disable allowance of 204 response from ICAP server. Valid values: disable, enable.
N204SizeLimit double
204 response size limit to be saved by ICAP client in megabytes (1 - 10, default = 1 MB).
Name string
ICAP profile name.
ObjectIcapProfileId string
an identifier for the resource with format {{name}}.
Preview string
Enable/disable preview of data to ICAP server. Valid values: disable, enable.
PreviewDataLength double
Preview data length to be sent to ICAP server.
ReplacemsgGroup string
Replacement message group.
Request string
Enable/disable whether an HTTP request is passed to an ICAP server. Valid values: disable, enable.
RequestFailure string
Action to take if the ICAP server cannot be contacted when processing an HTTP request. Valid values: error, bypass.
RequestPath string
Path component of the ICAP URI that identifies the HTTP request processing service.
RequestServer string
ICAP server to use for an HTTP request.
RespmodDefaultAction string
Default action to ICAP response modification (respmod) processing. Valid values: bypass, forward.
RespmodForwardRules List<ObjectIcapProfileRespmodForwardRule>
Respmod-Forward-Rules. The structure of respmod_forward_rules block is documented below.
Response string
Enable/disable whether an HTTP response is passed to an ICAP server. Valid values: disable, enable.
ResponseFailure string
Action to take if the ICAP server cannot be contacted when processing an HTTP response. Valid values: error, bypass.
ResponsePath string
Path component of the ICAP URI that identifies the HTTP response processing service.
ResponseReqHdr string
Enable/disable addition of req-hdr for ICAP response modification (respmod) processing. Valid values: disable, enable.
ResponseServer string
ICAP server to use for an HTTP response.
ScanProgressInterval double
Scan progress interval value.
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.
StreamingContentBypass string
Enable/disable bypassing of ICAP server for streaming content. Valid values: disable, enable.
Timeout double
Time (in seconds) that ICAP client waits for the response from ICAP server.
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
ChunkEncap string
Enable/disable chunked encapsulation (default = disable). Valid values: disable, enable.
Comment string
Comment.
DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
ExtensionFeatures []string
Enable/disable ICAP extension features. Valid values: scan-progress.
FileTransferFailure string
Action to take if the ICAP server cannot be contacted when processing a file transfer. Valid values: error, bypass.
FileTransferPath string
Path component of the ICAP URI that identifies the file transfer processing service.
FileTransferServer string
ICAP server to use for a file transfer.
FileTransfers []string
Configure the file transfer protocols to pass transferred files to an ICAP server as REQMOD. Valid values: ssh, ftp.
IcapBlockLog string
Enable/disable UTM log when infection found (default = disable). Valid values: disable, enable.
IcapHeaders []ObjectIcapProfileIcapHeaderArgs
Icap-Headers. The structure of icap_headers block is documented below.
Methods []string
The allowed HTTP methods that will be sent to ICAP server for further processing. Valid values: delete, get, head, options, post, put, trace, other.
N204Response string
Enable/disable allowance of 204 response from ICAP server. Valid values: disable, enable.
N204SizeLimit float64
204 response size limit to be saved by ICAP client in megabytes (1 - 10, default = 1 MB).
Name string
ICAP profile name.
ObjectIcapProfileId string
an identifier for the resource with format {{name}}.
Preview string
Enable/disable preview of data to ICAP server. Valid values: disable, enable.
PreviewDataLength float64
Preview data length to be sent to ICAP server.
ReplacemsgGroup string
Replacement message group.
Request string
Enable/disable whether an HTTP request is passed to an ICAP server. Valid values: disable, enable.
RequestFailure string
Action to take if the ICAP server cannot be contacted when processing an HTTP request. Valid values: error, bypass.
RequestPath string
Path component of the ICAP URI that identifies the HTTP request processing service.
RequestServer string
ICAP server to use for an HTTP request.
RespmodDefaultAction string
Default action to ICAP response modification (respmod) processing. Valid values: bypass, forward.
RespmodForwardRules []ObjectIcapProfileRespmodForwardRuleArgs
Respmod-Forward-Rules. The structure of respmod_forward_rules block is documented below.
Response string
Enable/disable whether an HTTP response is passed to an ICAP server. Valid values: disable, enable.
ResponseFailure string
Action to take if the ICAP server cannot be contacted when processing an HTTP response. Valid values: error, bypass.
ResponsePath string
Path component of the ICAP URI that identifies the HTTP response processing service.
ResponseReqHdr string
Enable/disable addition of req-hdr for ICAP response modification (respmod) processing. Valid values: disable, enable.
ResponseServer string
ICAP server to use for an HTTP response.
ScanProgressInterval float64
Scan progress interval value.
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.
StreamingContentBypass string
Enable/disable bypassing of ICAP server for streaming content. Valid values: disable, enable.
Timeout float64
Time (in seconds) that ICAP client waits for the response from ICAP server.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
chunkEncap String
Enable/disable chunked encapsulation (default = disable). Valid values: disable, enable.
comment String
Comment.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
extensionFeatures List<String>
Enable/disable ICAP extension features. Valid values: scan-progress.
fileTransferFailure String
Action to take if the ICAP server cannot be contacted when processing a file transfer. Valid values: error, bypass.
fileTransferPath String
Path component of the ICAP URI that identifies the file transfer processing service.
fileTransferServer String
ICAP server to use for a file transfer.
fileTransfers List<String>
Configure the file transfer protocols to pass transferred files to an ICAP server as REQMOD. Valid values: ssh, ftp.
icapBlockLog String
Enable/disable UTM log when infection found (default = disable). Valid values: disable, enable.
icapHeaders List<ObjectIcapProfileIcapHeader>
Icap-Headers. The structure of icap_headers block is documented below.
methods List<String>
The allowed HTTP methods that will be sent to ICAP server for further processing. Valid values: delete, get, head, options, post, put, trace, other.
n204Response String
Enable/disable allowance of 204 response from ICAP server. Valid values: disable, enable.
n204SizeLimit Double
204 response size limit to be saved by ICAP client in megabytes (1 - 10, default = 1 MB).
name String
ICAP profile name.
objectIcapProfileId String
an identifier for the resource with format {{name}}.
preview String
Enable/disable preview of data to ICAP server. Valid values: disable, enable.
previewDataLength Double
Preview data length to be sent to ICAP server.
replacemsgGroup String
Replacement message group.
request String
Enable/disable whether an HTTP request is passed to an ICAP server. Valid values: disable, enable.
requestFailure String
Action to take if the ICAP server cannot be contacted when processing an HTTP request. Valid values: error, bypass.
requestPath String
Path component of the ICAP URI that identifies the HTTP request processing service.
requestServer String
ICAP server to use for an HTTP request.
respmodDefaultAction String
Default action to ICAP response modification (respmod) processing. Valid values: bypass, forward.
respmodForwardRules List<ObjectIcapProfileRespmodForwardRule>
Respmod-Forward-Rules. The structure of respmod_forward_rules block is documented below.
response String
Enable/disable whether an HTTP response is passed to an ICAP server. Valid values: disable, enable.
responseFailure String
Action to take if the ICAP server cannot be contacted when processing an HTTP response. Valid values: error, bypass.
responsePath String
Path component of the ICAP URI that identifies the HTTP response processing service.
responseReqHdr String
Enable/disable addition of req-hdr for ICAP response modification (respmod) processing. Valid values: disable, enable.
responseServer String
ICAP server to use for an HTTP response.
scanProgressInterval Double
Scan progress interval value.
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.
streamingContentBypass String
Enable/disable bypassing of ICAP server for streaming content. Valid values: disable, enable.
timeout Double
Time (in seconds) that ICAP client waits for the response from ICAP server.
adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
chunkEncap string
Enable/disable chunked encapsulation (default = disable). Valid values: disable, enable.
comment string
Comment.
dynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
extensionFeatures string[]
Enable/disable ICAP extension features. Valid values: scan-progress.
fileTransferFailure string
Action to take if the ICAP server cannot be contacted when processing a file transfer. Valid values: error, bypass.
fileTransferPath string
Path component of the ICAP URI that identifies the file transfer processing service.
fileTransferServer string
ICAP server to use for a file transfer.
fileTransfers string[]
Configure the file transfer protocols to pass transferred files to an ICAP server as REQMOD. Valid values: ssh, ftp.
icapBlockLog string
Enable/disable UTM log when infection found (default = disable). Valid values: disable, enable.
icapHeaders ObjectIcapProfileIcapHeader[]
Icap-Headers. The structure of icap_headers block is documented below.
methods string[]
The allowed HTTP methods that will be sent to ICAP server for further processing. Valid values: delete, get, head, options, post, put, trace, other.
n204Response string
Enable/disable allowance of 204 response from ICAP server. Valid values: disable, enable.
n204SizeLimit number
204 response size limit to be saved by ICAP client in megabytes (1 - 10, default = 1 MB).
name string
ICAP profile name.
objectIcapProfileId string
an identifier for the resource with format {{name}}.
preview string
Enable/disable preview of data to ICAP server. Valid values: disable, enable.
previewDataLength number
Preview data length to be sent to ICAP server.
replacemsgGroup string
Replacement message group.
request string
Enable/disable whether an HTTP request is passed to an ICAP server. Valid values: disable, enable.
requestFailure string
Action to take if the ICAP server cannot be contacted when processing an HTTP request. Valid values: error, bypass.
requestPath string
Path component of the ICAP URI that identifies the HTTP request processing service.
requestServer string
ICAP server to use for an HTTP request.
respmodDefaultAction string
Default action to ICAP response modification (respmod) processing. Valid values: bypass, forward.
respmodForwardRules ObjectIcapProfileRespmodForwardRule[]
Respmod-Forward-Rules. The structure of respmod_forward_rules block is documented below.
response string
Enable/disable whether an HTTP response is passed to an ICAP server. Valid values: disable, enable.
responseFailure string
Action to take if the ICAP server cannot be contacted when processing an HTTP response. Valid values: error, bypass.
responsePath string
Path component of the ICAP URI that identifies the HTTP response processing service.
responseReqHdr string
Enable/disable addition of req-hdr for ICAP response modification (respmod) processing. Valid values: disable, enable.
responseServer string
ICAP server to use for an HTTP response.
scanProgressInterval number
Scan progress interval value.
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.
streamingContentBypass string
Enable/disable bypassing of ICAP server for streaming content. Valid values: disable, enable.
timeout number
Time (in seconds) that ICAP client waits for the response from ICAP server.
adom str
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
chunk_encap str
Enable/disable chunked encapsulation (default = disable). Valid values: disable, enable.
comment str
Comment.
dynamic_sort_subtable str
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
extension_features Sequence[str]
Enable/disable ICAP extension features. Valid values: scan-progress.
file_transfer_failure str
Action to take if the ICAP server cannot be contacted when processing a file transfer. Valid values: error, bypass.
file_transfer_path str
Path component of the ICAP URI that identifies the file transfer processing service.
file_transfer_server str
ICAP server to use for a file transfer.
file_transfers Sequence[str]
Configure the file transfer protocols to pass transferred files to an ICAP server as REQMOD. Valid values: ssh, ftp.
icap_block_log str
Enable/disable UTM log when infection found (default = disable). Valid values: disable, enable.
icap_headers Sequence[ObjectIcapProfileIcapHeaderArgs]
Icap-Headers. The structure of icap_headers block is documented below.
methods Sequence[str]
The allowed HTTP methods that will be sent to ICAP server for further processing. Valid values: delete, get, head, options, post, put, trace, other.
n204_response str
Enable/disable allowance of 204 response from ICAP server. Valid values: disable, enable.
n204_size_limit float
204 response size limit to be saved by ICAP client in megabytes (1 - 10, default = 1 MB).
name str
ICAP profile name.
object_icap_profile_id str
an identifier for the resource with format {{name}}.
preview str
Enable/disable preview of data to ICAP server. Valid values: disable, enable.
preview_data_length float
Preview data length to be sent to ICAP server.
replacemsg_group str
Replacement message group.
request str
Enable/disable whether an HTTP request is passed to an ICAP server. Valid values: disable, enable.
request_failure str
Action to take if the ICAP server cannot be contacted when processing an HTTP request. Valid values: error, bypass.
request_path str
Path component of the ICAP URI that identifies the HTTP request processing service.
request_server str
ICAP server to use for an HTTP request.
respmod_default_action str
Default action to ICAP response modification (respmod) processing. Valid values: bypass, forward.
respmod_forward_rules Sequence[ObjectIcapProfileRespmodForwardRuleArgs]
Respmod-Forward-Rules. The structure of respmod_forward_rules block is documented below.
response str
Enable/disable whether an HTTP response is passed to an ICAP server. Valid values: disable, enable.
response_failure str
Action to take if the ICAP server cannot be contacted when processing an HTTP response. Valid values: error, bypass.
response_path str
Path component of the ICAP URI that identifies the HTTP response processing service.
response_req_hdr str
Enable/disable addition of req-hdr for ICAP response modification (respmod) processing. Valid values: disable, enable.
response_server str
ICAP server to use for an HTTP response.
scan_progress_interval float
Scan progress interval value.
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.
streaming_content_bypass str
Enable/disable bypassing of ICAP server for streaming content. Valid values: disable, enable.
timeout float
Time (in seconds) that ICAP client waits for the response from ICAP server.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
chunkEncap String
Enable/disable chunked encapsulation (default = disable). Valid values: disable, enable.
comment String
Comment.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
extensionFeatures List<String>
Enable/disable ICAP extension features. Valid values: scan-progress.
fileTransferFailure String
Action to take if the ICAP server cannot be contacted when processing a file transfer. Valid values: error, bypass.
fileTransferPath String
Path component of the ICAP URI that identifies the file transfer processing service.
fileTransferServer String
ICAP server to use for a file transfer.
fileTransfers List<String>
Configure the file transfer protocols to pass transferred files to an ICAP server as REQMOD. Valid values: ssh, ftp.
icapBlockLog String
Enable/disable UTM log when infection found (default = disable). Valid values: disable, enable.
icapHeaders List<Property Map>
Icap-Headers. The structure of icap_headers block is documented below.
methods List<String>
The allowed HTTP methods that will be sent to ICAP server for further processing. Valid values: delete, get, head, options, post, put, trace, other.
n204Response String
Enable/disable allowance of 204 response from ICAP server. Valid values: disable, enable.
n204SizeLimit Number
204 response size limit to be saved by ICAP client in megabytes (1 - 10, default = 1 MB).
name String
ICAP profile name.
objectIcapProfileId String
an identifier for the resource with format {{name}}.
preview String
Enable/disable preview of data to ICAP server. Valid values: disable, enable.
previewDataLength Number
Preview data length to be sent to ICAP server.
replacemsgGroup String
Replacement message group.
request String
Enable/disable whether an HTTP request is passed to an ICAP server. Valid values: disable, enable.
requestFailure String
Action to take if the ICAP server cannot be contacted when processing an HTTP request. Valid values: error, bypass.
requestPath String
Path component of the ICAP URI that identifies the HTTP request processing service.
requestServer String
ICAP server to use for an HTTP request.
respmodDefaultAction String
Default action to ICAP response modification (respmod) processing. Valid values: bypass, forward.
respmodForwardRules List<Property Map>
Respmod-Forward-Rules. The structure of respmod_forward_rules block is documented below.
response String
Enable/disable whether an HTTP response is passed to an ICAP server. Valid values: disable, enable.
responseFailure String
Action to take if the ICAP server cannot be contacted when processing an HTTP response. Valid values: error, bypass.
responsePath String
Path component of the ICAP URI that identifies the HTTP response processing service.
responseReqHdr String
Enable/disable addition of req-hdr for ICAP response modification (respmod) processing. Valid values: disable, enable.
responseServer String
ICAP server to use for an HTTP response.
scanProgressInterval Number
Scan progress interval value.
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.
streamingContentBypass String
Enable/disable bypassing of ICAP server for streaming content. Valid values: disable, enable.
timeout Number
Time (in seconds) that ICAP client waits for the response from ICAP server.

Outputs

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

Get an existing ObjectIcapProfile 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?: ObjectIcapProfileState, opts?: CustomResourceOptions): ObjectIcapProfile
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        adom: Optional[str] = None,
        chunk_encap: Optional[str] = None,
        comment: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        extension_features: Optional[Sequence[str]] = None,
        file_transfer_failure: Optional[str] = None,
        file_transfer_path: Optional[str] = None,
        file_transfer_server: Optional[str] = None,
        file_transfers: Optional[Sequence[str]] = None,
        icap_block_log: Optional[str] = None,
        icap_headers: Optional[Sequence[ObjectIcapProfileIcapHeaderArgs]] = None,
        methods: Optional[Sequence[str]] = None,
        n204_response: Optional[str] = None,
        n204_size_limit: Optional[float] = None,
        name: Optional[str] = None,
        object_icap_profile_id: Optional[str] = None,
        preview: Optional[str] = None,
        preview_data_length: Optional[float] = None,
        replacemsg_group: Optional[str] = None,
        request: Optional[str] = None,
        request_failure: Optional[str] = None,
        request_path: Optional[str] = None,
        request_server: Optional[str] = None,
        respmod_default_action: Optional[str] = None,
        respmod_forward_rules: Optional[Sequence[ObjectIcapProfileRespmodForwardRuleArgs]] = None,
        response: Optional[str] = None,
        response_failure: Optional[str] = None,
        response_path: Optional[str] = None,
        response_req_hdr: Optional[str] = None,
        response_server: Optional[str] = None,
        scan_progress_interval: Optional[float] = None,
        scopetype: Optional[str] = None,
        streaming_content_bypass: Optional[str] = None,
        timeout: Optional[float] = None) -> ObjectIcapProfile
func GetObjectIcapProfile(ctx *Context, name string, id IDInput, state *ObjectIcapProfileState, opts ...ResourceOption) (*ObjectIcapProfile, error)
public static ObjectIcapProfile Get(string name, Input<string> id, ObjectIcapProfileState? state, CustomResourceOptions? opts = null)
public static ObjectIcapProfile get(String name, Output<String> id, ObjectIcapProfileState state, CustomResourceOptions options)
resources:  _:    type: fortimanager:ObjectIcapProfile    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:
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
ChunkEncap string
Enable/disable chunked encapsulation (default = disable). Valid values: disable, enable.
Comment string
Comment.
DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
ExtensionFeatures List<string>
Enable/disable ICAP extension features. Valid values: scan-progress.
FileTransferFailure string
Action to take if the ICAP server cannot be contacted when processing a file transfer. Valid values: error, bypass.
FileTransferPath string
Path component of the ICAP URI that identifies the file transfer processing service.
FileTransferServer string
ICAP server to use for a file transfer.
FileTransfers List<string>
Configure the file transfer protocols to pass transferred files to an ICAP server as REQMOD. Valid values: ssh, ftp.
IcapBlockLog string
Enable/disable UTM log when infection found (default = disable). Valid values: disable, enable.
IcapHeaders List<ObjectIcapProfileIcapHeader>
Icap-Headers. The structure of icap_headers block is documented below.
Methods List<string>
The allowed HTTP methods that will be sent to ICAP server for further processing. Valid values: delete, get, head, options, post, put, trace, other.
N204Response string
Enable/disable allowance of 204 response from ICAP server. Valid values: disable, enable.
N204SizeLimit double
204 response size limit to be saved by ICAP client in megabytes (1 - 10, default = 1 MB).
Name string
ICAP profile name.
ObjectIcapProfileId string
an identifier for the resource with format {{name}}.
Preview string
Enable/disable preview of data to ICAP server. Valid values: disable, enable.
PreviewDataLength double
Preview data length to be sent to ICAP server.
ReplacemsgGroup string
Replacement message group.
Request string
Enable/disable whether an HTTP request is passed to an ICAP server. Valid values: disable, enable.
RequestFailure string
Action to take if the ICAP server cannot be contacted when processing an HTTP request. Valid values: error, bypass.
RequestPath string
Path component of the ICAP URI that identifies the HTTP request processing service.
RequestServer string
ICAP server to use for an HTTP request.
RespmodDefaultAction string
Default action to ICAP response modification (respmod) processing. Valid values: bypass, forward.
RespmodForwardRules List<ObjectIcapProfileRespmodForwardRule>
Respmod-Forward-Rules. The structure of respmod_forward_rules block is documented below.
Response string
Enable/disable whether an HTTP response is passed to an ICAP server. Valid values: disable, enable.
ResponseFailure string
Action to take if the ICAP server cannot be contacted when processing an HTTP response. Valid values: error, bypass.
ResponsePath string
Path component of the ICAP URI that identifies the HTTP response processing service.
ResponseReqHdr string
Enable/disable addition of req-hdr for ICAP response modification (respmod) processing. Valid values: disable, enable.
ResponseServer string
ICAP server to use for an HTTP response.
ScanProgressInterval double
Scan progress interval value.
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.
StreamingContentBypass string
Enable/disable bypassing of ICAP server for streaming content. Valid values: disable, enable.
Timeout double
Time (in seconds) that ICAP client waits for the response from ICAP server.
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
ChunkEncap string
Enable/disable chunked encapsulation (default = disable). Valid values: disable, enable.
Comment string
Comment.
DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
ExtensionFeatures []string
Enable/disable ICAP extension features. Valid values: scan-progress.
FileTransferFailure string
Action to take if the ICAP server cannot be contacted when processing a file transfer. Valid values: error, bypass.
FileTransferPath string
Path component of the ICAP URI that identifies the file transfer processing service.
FileTransferServer string
ICAP server to use for a file transfer.
FileTransfers []string
Configure the file transfer protocols to pass transferred files to an ICAP server as REQMOD. Valid values: ssh, ftp.
IcapBlockLog string
Enable/disable UTM log when infection found (default = disable). Valid values: disable, enable.
IcapHeaders []ObjectIcapProfileIcapHeaderArgs
Icap-Headers. The structure of icap_headers block is documented below.
Methods []string
The allowed HTTP methods that will be sent to ICAP server for further processing. Valid values: delete, get, head, options, post, put, trace, other.
N204Response string
Enable/disable allowance of 204 response from ICAP server. Valid values: disable, enable.
N204SizeLimit float64
204 response size limit to be saved by ICAP client in megabytes (1 - 10, default = 1 MB).
Name string
ICAP profile name.
ObjectIcapProfileId string
an identifier for the resource with format {{name}}.
Preview string
Enable/disable preview of data to ICAP server. Valid values: disable, enable.
PreviewDataLength float64
Preview data length to be sent to ICAP server.
ReplacemsgGroup string
Replacement message group.
Request string
Enable/disable whether an HTTP request is passed to an ICAP server. Valid values: disable, enable.
RequestFailure string
Action to take if the ICAP server cannot be contacted when processing an HTTP request. Valid values: error, bypass.
RequestPath string
Path component of the ICAP URI that identifies the HTTP request processing service.
RequestServer string
ICAP server to use for an HTTP request.
RespmodDefaultAction string
Default action to ICAP response modification (respmod) processing. Valid values: bypass, forward.
RespmodForwardRules []ObjectIcapProfileRespmodForwardRuleArgs
Respmod-Forward-Rules. The structure of respmod_forward_rules block is documented below.
Response string
Enable/disable whether an HTTP response is passed to an ICAP server. Valid values: disable, enable.
ResponseFailure string
Action to take if the ICAP server cannot be contacted when processing an HTTP response. Valid values: error, bypass.
ResponsePath string
Path component of the ICAP URI that identifies the HTTP response processing service.
ResponseReqHdr string
Enable/disable addition of req-hdr for ICAP response modification (respmod) processing. Valid values: disable, enable.
ResponseServer string
ICAP server to use for an HTTP response.
ScanProgressInterval float64
Scan progress interval value.
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.
StreamingContentBypass string
Enable/disable bypassing of ICAP server for streaming content. Valid values: disable, enable.
Timeout float64
Time (in seconds) that ICAP client waits for the response from ICAP server.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
chunkEncap String
Enable/disable chunked encapsulation (default = disable). Valid values: disable, enable.
comment String
Comment.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
extensionFeatures List<String>
Enable/disable ICAP extension features. Valid values: scan-progress.
fileTransferFailure String
Action to take if the ICAP server cannot be contacted when processing a file transfer. Valid values: error, bypass.
fileTransferPath String
Path component of the ICAP URI that identifies the file transfer processing service.
fileTransferServer String
ICAP server to use for a file transfer.
fileTransfers List<String>
Configure the file transfer protocols to pass transferred files to an ICAP server as REQMOD. Valid values: ssh, ftp.
icapBlockLog String
Enable/disable UTM log when infection found (default = disable). Valid values: disable, enable.
icapHeaders List<ObjectIcapProfileIcapHeader>
Icap-Headers. The structure of icap_headers block is documented below.
methods List<String>
The allowed HTTP methods that will be sent to ICAP server for further processing. Valid values: delete, get, head, options, post, put, trace, other.
n204Response String
Enable/disable allowance of 204 response from ICAP server. Valid values: disable, enable.
n204SizeLimit Double
204 response size limit to be saved by ICAP client in megabytes (1 - 10, default = 1 MB).
name String
ICAP profile name.
objectIcapProfileId String
an identifier for the resource with format {{name}}.
preview String
Enable/disable preview of data to ICAP server. Valid values: disable, enable.
previewDataLength Double
Preview data length to be sent to ICAP server.
replacemsgGroup String
Replacement message group.
request String
Enable/disable whether an HTTP request is passed to an ICAP server. Valid values: disable, enable.
requestFailure String
Action to take if the ICAP server cannot be contacted when processing an HTTP request. Valid values: error, bypass.
requestPath String
Path component of the ICAP URI that identifies the HTTP request processing service.
requestServer String
ICAP server to use for an HTTP request.
respmodDefaultAction String
Default action to ICAP response modification (respmod) processing. Valid values: bypass, forward.
respmodForwardRules List<ObjectIcapProfileRespmodForwardRule>
Respmod-Forward-Rules. The structure of respmod_forward_rules block is documented below.
response String
Enable/disable whether an HTTP response is passed to an ICAP server. Valid values: disable, enable.
responseFailure String
Action to take if the ICAP server cannot be contacted when processing an HTTP response. Valid values: error, bypass.
responsePath String
Path component of the ICAP URI that identifies the HTTP response processing service.
responseReqHdr String
Enable/disable addition of req-hdr for ICAP response modification (respmod) processing. Valid values: disable, enable.
responseServer String
ICAP server to use for an HTTP response.
scanProgressInterval Double
Scan progress interval value.
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.
streamingContentBypass String
Enable/disable bypassing of ICAP server for streaming content. Valid values: disable, enable.
timeout Double
Time (in seconds) that ICAP client waits for the response from ICAP server.
adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
chunkEncap string
Enable/disable chunked encapsulation (default = disable). Valid values: disable, enable.
comment string
Comment.
dynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
extensionFeatures string[]
Enable/disable ICAP extension features. Valid values: scan-progress.
fileTransferFailure string
Action to take if the ICAP server cannot be contacted when processing a file transfer. Valid values: error, bypass.
fileTransferPath string
Path component of the ICAP URI that identifies the file transfer processing service.
fileTransferServer string
ICAP server to use for a file transfer.
fileTransfers string[]
Configure the file transfer protocols to pass transferred files to an ICAP server as REQMOD. Valid values: ssh, ftp.
icapBlockLog string
Enable/disable UTM log when infection found (default = disable). Valid values: disable, enable.
icapHeaders ObjectIcapProfileIcapHeader[]
Icap-Headers. The structure of icap_headers block is documented below.
methods string[]
The allowed HTTP methods that will be sent to ICAP server for further processing. Valid values: delete, get, head, options, post, put, trace, other.
n204Response string
Enable/disable allowance of 204 response from ICAP server. Valid values: disable, enable.
n204SizeLimit number
204 response size limit to be saved by ICAP client in megabytes (1 - 10, default = 1 MB).
name string
ICAP profile name.
objectIcapProfileId string
an identifier for the resource with format {{name}}.
preview string
Enable/disable preview of data to ICAP server. Valid values: disable, enable.
previewDataLength number
Preview data length to be sent to ICAP server.
replacemsgGroup string
Replacement message group.
request string
Enable/disable whether an HTTP request is passed to an ICAP server. Valid values: disable, enable.
requestFailure string
Action to take if the ICAP server cannot be contacted when processing an HTTP request. Valid values: error, bypass.
requestPath string
Path component of the ICAP URI that identifies the HTTP request processing service.
requestServer string
ICAP server to use for an HTTP request.
respmodDefaultAction string
Default action to ICAP response modification (respmod) processing. Valid values: bypass, forward.
respmodForwardRules ObjectIcapProfileRespmodForwardRule[]
Respmod-Forward-Rules. The structure of respmod_forward_rules block is documented below.
response string
Enable/disable whether an HTTP response is passed to an ICAP server. Valid values: disable, enable.
responseFailure string
Action to take if the ICAP server cannot be contacted when processing an HTTP response. Valid values: error, bypass.
responsePath string
Path component of the ICAP URI that identifies the HTTP response processing service.
responseReqHdr string
Enable/disable addition of req-hdr for ICAP response modification (respmod) processing. Valid values: disable, enable.
responseServer string
ICAP server to use for an HTTP response.
scanProgressInterval number
Scan progress interval value.
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.
streamingContentBypass string
Enable/disable bypassing of ICAP server for streaming content. Valid values: disable, enable.
timeout number
Time (in seconds) that ICAP client waits for the response from ICAP server.
adom str
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
chunk_encap str
Enable/disable chunked encapsulation (default = disable). Valid values: disable, enable.
comment str
Comment.
dynamic_sort_subtable str
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
extension_features Sequence[str]
Enable/disable ICAP extension features. Valid values: scan-progress.
file_transfer_failure str
Action to take if the ICAP server cannot be contacted when processing a file transfer. Valid values: error, bypass.
file_transfer_path str
Path component of the ICAP URI that identifies the file transfer processing service.
file_transfer_server str
ICAP server to use for a file transfer.
file_transfers Sequence[str]
Configure the file transfer protocols to pass transferred files to an ICAP server as REQMOD. Valid values: ssh, ftp.
icap_block_log str
Enable/disable UTM log when infection found (default = disable). Valid values: disable, enable.
icap_headers Sequence[ObjectIcapProfileIcapHeaderArgs]
Icap-Headers. The structure of icap_headers block is documented below.
methods Sequence[str]
The allowed HTTP methods that will be sent to ICAP server for further processing. Valid values: delete, get, head, options, post, put, trace, other.
n204_response str
Enable/disable allowance of 204 response from ICAP server. Valid values: disable, enable.
n204_size_limit float
204 response size limit to be saved by ICAP client in megabytes (1 - 10, default = 1 MB).
name str
ICAP profile name.
object_icap_profile_id str
an identifier for the resource with format {{name}}.
preview str
Enable/disable preview of data to ICAP server. Valid values: disable, enable.
preview_data_length float
Preview data length to be sent to ICAP server.
replacemsg_group str
Replacement message group.
request str
Enable/disable whether an HTTP request is passed to an ICAP server. Valid values: disable, enable.
request_failure str
Action to take if the ICAP server cannot be contacted when processing an HTTP request. Valid values: error, bypass.
request_path str
Path component of the ICAP URI that identifies the HTTP request processing service.
request_server str
ICAP server to use for an HTTP request.
respmod_default_action str
Default action to ICAP response modification (respmod) processing. Valid values: bypass, forward.
respmod_forward_rules Sequence[ObjectIcapProfileRespmodForwardRuleArgs]
Respmod-Forward-Rules. The structure of respmod_forward_rules block is documented below.
response str
Enable/disable whether an HTTP response is passed to an ICAP server. Valid values: disable, enable.
response_failure str
Action to take if the ICAP server cannot be contacted when processing an HTTP response. Valid values: error, bypass.
response_path str
Path component of the ICAP URI that identifies the HTTP response processing service.
response_req_hdr str
Enable/disable addition of req-hdr for ICAP response modification (respmod) processing. Valid values: disable, enable.
response_server str
ICAP server to use for an HTTP response.
scan_progress_interval float
Scan progress interval value.
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.
streaming_content_bypass str
Enable/disable bypassing of ICAP server for streaming content. Valid values: disable, enable.
timeout float
Time (in seconds) that ICAP client waits for the response from ICAP server.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
chunkEncap String
Enable/disable chunked encapsulation (default = disable). Valid values: disable, enable.
comment String
Comment.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
extensionFeatures List<String>
Enable/disable ICAP extension features. Valid values: scan-progress.
fileTransferFailure String
Action to take if the ICAP server cannot be contacted when processing a file transfer. Valid values: error, bypass.
fileTransferPath String
Path component of the ICAP URI that identifies the file transfer processing service.
fileTransferServer String
ICAP server to use for a file transfer.
fileTransfers List<String>
Configure the file transfer protocols to pass transferred files to an ICAP server as REQMOD. Valid values: ssh, ftp.
icapBlockLog String
Enable/disable UTM log when infection found (default = disable). Valid values: disable, enable.
icapHeaders List<Property Map>
Icap-Headers. The structure of icap_headers block is documented below.
methods List<String>
The allowed HTTP methods that will be sent to ICAP server for further processing. Valid values: delete, get, head, options, post, put, trace, other.
n204Response String
Enable/disable allowance of 204 response from ICAP server. Valid values: disable, enable.
n204SizeLimit Number
204 response size limit to be saved by ICAP client in megabytes (1 - 10, default = 1 MB).
name String
ICAP profile name.
objectIcapProfileId String
an identifier for the resource with format {{name}}.
preview String
Enable/disable preview of data to ICAP server. Valid values: disable, enable.
previewDataLength Number
Preview data length to be sent to ICAP server.
replacemsgGroup String
Replacement message group.
request String
Enable/disable whether an HTTP request is passed to an ICAP server. Valid values: disable, enable.
requestFailure String
Action to take if the ICAP server cannot be contacted when processing an HTTP request. Valid values: error, bypass.
requestPath String
Path component of the ICAP URI that identifies the HTTP request processing service.
requestServer String
ICAP server to use for an HTTP request.
respmodDefaultAction String
Default action to ICAP response modification (respmod) processing. Valid values: bypass, forward.
respmodForwardRules List<Property Map>
Respmod-Forward-Rules. The structure of respmod_forward_rules block is documented below.
response String
Enable/disable whether an HTTP response is passed to an ICAP server. Valid values: disable, enable.
responseFailure String
Action to take if the ICAP server cannot be contacted when processing an HTTP response. Valid values: error, bypass.
responsePath String
Path component of the ICAP URI that identifies the HTTP response processing service.
responseReqHdr String
Enable/disable addition of req-hdr for ICAP response modification (respmod) processing. Valid values: disable, enable.
responseServer String
ICAP server to use for an HTTP response.
scanProgressInterval Number
Scan progress interval value.
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.
streamingContentBypass String
Enable/disable bypassing of ICAP server for streaming content. Valid values: disable, enable.
timeout Number
Time (in seconds) that ICAP client waits for the response from ICAP server.

Supporting Types

ObjectIcapProfileIcapHeader
, ObjectIcapProfileIcapHeaderArgs

Base64Encoding string
Enable/disable use of base64 encoding of HTTP content. Valid values: disable, enable.
Content string
HTTP header content.
Id double
HTTP forwarded header ID.
Name string
HTTP forwarded header name.
Base64Encoding string
Enable/disable use of base64 encoding of HTTP content. Valid values: disable, enable.
Content string
HTTP header content.
Id float64
HTTP forwarded header ID.
Name string
HTTP forwarded header name.
base64Encoding String
Enable/disable use of base64 encoding of HTTP content. Valid values: disable, enable.
content String
HTTP header content.
id Double
HTTP forwarded header ID.
name String
HTTP forwarded header name.
base64Encoding string
Enable/disable use of base64 encoding of HTTP content. Valid values: disable, enable.
content string
HTTP header content.
id number
HTTP forwarded header ID.
name string
HTTP forwarded header name.
base64_encoding str
Enable/disable use of base64 encoding of HTTP content. Valid values: disable, enable.
content str
HTTP header content.
id float
HTTP forwarded header ID.
name str
HTTP forwarded header name.
base64Encoding String
Enable/disable use of base64 encoding of HTTP content. Valid values: disable, enable.
content String
HTTP header content.
id Number
HTTP forwarded header ID.
name String
HTTP forwarded header name.

ObjectIcapProfileRespmodForwardRule
, ObjectIcapProfileRespmodForwardRuleArgs

Action string
Action to be taken for ICAP server. Valid values: bypass, forward.
HeaderGroups List<ObjectIcapProfileRespmodForwardRuleHeaderGroup>
Header-Group. The structure of header_group block is documented below.
Host string
Address object for the host.
HttpRespStatusCodes List<double>
HTTP response status code.
Name string
Address name.
Action string
Action to be taken for ICAP server. Valid values: bypass, forward.
HeaderGroups []ObjectIcapProfileRespmodForwardRuleHeaderGroup
Header-Group. The structure of header_group block is documented below.
Host string
Address object for the host.
HttpRespStatusCodes []float64
HTTP response status code.
Name string
Address name.
action String
Action to be taken for ICAP server. Valid values: bypass, forward.
headerGroups List<ObjectIcapProfileRespmodForwardRuleHeaderGroup>
Header-Group. The structure of header_group block is documented below.
host String
Address object for the host.
httpRespStatusCodes List<Double>
HTTP response status code.
name String
Address name.
action string
Action to be taken for ICAP server. Valid values: bypass, forward.
headerGroups ObjectIcapProfileRespmodForwardRuleHeaderGroup[]
Header-Group. The structure of header_group block is documented below.
host string
Address object for the host.
httpRespStatusCodes number[]
HTTP response status code.
name string
Address name.
action str
Action to be taken for ICAP server. Valid values: bypass, forward.
header_groups Sequence[ObjectIcapProfileRespmodForwardRuleHeaderGroup]
Header-Group. The structure of header_group block is documented below.
host str
Address object for the host.
http_resp_status_codes Sequence[float]
HTTP response status code.
name str
Address name.
action String
Action to be taken for ICAP server. Valid values: bypass, forward.
headerGroups List<Property Map>
Header-Group. The structure of header_group block is documented below.
host String
Address object for the host.
httpRespStatusCodes List<Number>
HTTP response status code.
name String
Address name.

ObjectIcapProfileRespmodForwardRuleHeaderGroup
, ObjectIcapProfileRespmodForwardRuleHeaderGroupArgs

CaseSensitivity string
Enable/disable case sensitivity when matching header. Valid values: disable, enable.
Header string
HTTP header regular expression.
HeaderName string
HTTP header.
Id double
ID.
CaseSensitivity string
Enable/disable case sensitivity when matching header. Valid values: disable, enable.
Header string
HTTP header regular expression.
HeaderName string
HTTP header.
Id float64
ID.
caseSensitivity String
Enable/disable case sensitivity when matching header. Valid values: disable, enable.
header String
HTTP header regular expression.
headerName String
HTTP header.
id Double
ID.
caseSensitivity string
Enable/disable case sensitivity when matching header. Valid values: disable, enable.
header string
HTTP header regular expression.
headerName string
HTTP header.
id number
ID.
case_sensitivity str
Enable/disable case sensitivity when matching header. Valid values: disable, enable.
header str
HTTP header regular expression.
header_name str
HTTP header.
id float
ID.
caseSensitivity String
Enable/disable case sensitivity when matching header. Valid values: disable, enable.
header String
HTTP header regular expression.
headerName String
HTTP header.
id Number
ID.

Import

ObjectIcap Profile can be imported using any of these accepted formats:

$ export “FORTIMANAGER_IMPORT_TABLE”=“true”

$ pulumi import fortimanager:index/objectIcapProfile:ObjectIcapProfile labelname {{name}}
Copy

$ 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.
fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager