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

fortios.icap.Profile

Explore with Pulumi AI

Configure ICAP profiles.

Example Usage

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

const trname = new fortios.icap.Profile("trname", {
    icapHeaders: [{
        base64Encoding: "disable",
        content: "$user",
        name: "X-Authenticated-User",
    }],
    methods: "delete get head options post put trace other",
    request: "disable",
    requestFailure: "error",
    response: "disable",
    responseFailure: "error",
    responseReqHdr: "disable",
    streamingContentBypass: "disable",
});
Copy
import pulumi
import pulumiverse_fortios as fortios

trname = fortios.icap.Profile("trname",
    icap_headers=[fortios.icap.ProfileIcapHeaderArgs(
        base64_encoding="disable",
        content="$user",
        name="X-Authenticated-User",
    )],
    methods="delete get head options post put trace other",
    request="disable",
    request_failure="error",
    response="disable",
    response_failure="error",
    response_req_hdr="disable",
    streaming_content_bypass="disable")
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-fortios/sdk/go/fortios/icap"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := icap.NewProfile(ctx, "trname", &icap.ProfileArgs{
			IcapHeaders: icap.ProfileIcapHeaderArray{
				&icap.ProfileIcapHeaderArgs{
					Base64Encoding: pulumi.String("disable"),
					Content:        pulumi.String("$user"),
					Name:           pulumi.String("X-Authenticated-User"),
				},
			},
			Methods:                pulumi.String("delete get head options post put trace other"),
			Request:                pulumi.String("disable"),
			RequestFailure:         pulumi.String("error"),
			Response:               pulumi.String("disable"),
			ResponseFailure:        pulumi.String("error"),
			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 Fortios = Pulumiverse.Fortios;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortios.Icap.Profile("trname", new()
    {
        IcapHeaders = new[]
        {
            new Fortios.Icap.Inputs.ProfileIcapHeaderArgs
            {
                Base64Encoding = "disable",
                Content = "$user",
                Name = "X-Authenticated-User",
            },
        },
        Methods = "delete get head options post put trace other",
        Request = "disable",
        RequestFailure = "error",
        Response = "disable",
        ResponseFailure = "error",
        ResponseReqHdr = "disable",
        StreamingContentBypass = "disable",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.icap.Profile;
import com.pulumi.fortios.icap.ProfileArgs;
import com.pulumi.fortios.icap.inputs.ProfileIcapHeaderArgs;
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 Profile("trname", ProfileArgs.builder()
            .icapHeaders(ProfileIcapHeaderArgs.builder()
                .base64Encoding("disable")
                .content("$user")
                .name("X-Authenticated-User")
                .build())
            .methods("delete get head options post put trace other")
            .request("disable")
            .requestFailure("error")
            .response("disable")
            .responseFailure("error")
            .responseReqHdr("disable")
            .streamingContentBypass("disable")
            .build());

    }
}
Copy
resources:
  trname:
    type: fortios:icap:Profile
    properties:
      icapHeaders:
        - base64Encoding: disable
          content: $user
          name: X-Authenticated-User
      methods: delete get head options post put trace other
      request: disable
      requestFailure: error
      response: disable
      responseFailure: error
      responseReqHdr: disable
      streamingContentBypass: disable
Copy

Create Profile Resource

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

Constructor syntax

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

@overload
def Profile(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            chunk_encap: Optional[str] = None,
            comment: Optional[str] = None,
            dynamic_sort_subtable: Optional[str] = None,
            extension_feature: Optional[str] = None,
            file_transfer: Optional[str] = None,
            file_transfer_failure: Optional[str] = None,
            file_transfer_path: Optional[str] = None,
            file_transfer_server: Optional[str] = None,
            get_all_tables: Optional[str] = None,
            icap_block_log: Optional[str] = None,
            icap_headers: Optional[Sequence[ProfileIcapHeaderArgs]] = None,
            methods: Optional[str] = None,
            n204_response: Optional[str] = None,
            n204_size_limit: Optional[int] = None,
            name: Optional[str] = None,
            preview: Optional[str] = None,
            preview_data_length: Optional[int] = 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[ProfileRespmodForwardRuleArgs]] = 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[int] = None,
            streaming_content_bypass: Optional[str] = None,
            timeout: Optional[int] = None,
            vdomparam: Optional[str] = None)
func NewProfile(ctx *Context, name string, args *ProfileArgs, opts ...ResourceOption) (*Profile, error)
public Profile(string name, ProfileArgs? args = null, CustomResourceOptions? opts = null)
public Profile(String name, ProfileArgs args)
public Profile(String name, ProfileArgs args, CustomResourceOptions options)
type: fortios:icap:Profile
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 ProfileArgs
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 ProfileArgs
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 ProfileArgs
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 ProfileArgs
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. ProfileArgs
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 exampleprofileResourceResourceFromIcapprofile = new Fortios.Icap.Profile("exampleprofileResourceResourceFromIcapprofile", new()
{
    ChunkEncap = "string",
    Comment = "string",
    DynamicSortSubtable = "string",
    ExtensionFeature = "string",
    FileTransfer = "string",
    FileTransferFailure = "string",
    FileTransferPath = "string",
    FileTransferServer = "string",
    GetAllTables = "string",
    IcapBlockLog = "string",
    IcapHeaders = new[]
    {
        new Fortios.Icap.Inputs.ProfileIcapHeaderArgs
        {
            Base64Encoding = "string",
            Content = "string",
            Id = 0,
            Name = "string",
        },
    },
    Methods = "string",
    N204Response = "string",
    N204SizeLimit = 0,
    Name = "string",
    Preview = "string",
    PreviewDataLength = 0,
    ReplacemsgGroup = "string",
    Request = "string",
    RequestFailure = "string",
    RequestPath = "string",
    RequestServer = "string",
    RespmodDefaultAction = "string",
    RespmodForwardRules = new[]
    {
        new Fortios.Icap.Inputs.ProfileRespmodForwardRuleArgs
        {
            Action = "string",
            HeaderGroups = new[]
            {
                new Fortios.Icap.Inputs.ProfileRespmodForwardRuleHeaderGroupArgs
                {
                    CaseSensitivity = "string",
                    Header = "string",
                    HeaderName = "string",
                    Id = 0,
                },
            },
            Host = "string",
            HttpRespStatusCodes = new[]
            {
                new Fortios.Icap.Inputs.ProfileRespmodForwardRuleHttpRespStatusCodeArgs
                {
                    Code = 0,
                },
            },
            Name = "string",
        },
    },
    Response = "string",
    ResponseFailure = "string",
    ResponsePath = "string",
    ResponseReqHdr = "string",
    ResponseServer = "string",
    ScanProgressInterval = 0,
    StreamingContentBypass = "string",
    Timeout = 0,
    Vdomparam = "string",
});
Copy
example, err := icap.NewProfile(ctx, "exampleprofileResourceResourceFromIcapprofile", &icap.ProfileArgs{
	ChunkEncap:          pulumi.String("string"),
	Comment:             pulumi.String("string"),
	DynamicSortSubtable: pulumi.String("string"),
	ExtensionFeature:    pulumi.String("string"),
	FileTransfer:        pulumi.String("string"),
	FileTransferFailure: pulumi.String("string"),
	FileTransferPath:    pulumi.String("string"),
	FileTransferServer:  pulumi.String("string"),
	GetAllTables:        pulumi.String("string"),
	IcapBlockLog:        pulumi.String("string"),
	IcapHeaders: icap.ProfileIcapHeaderArray{
		&icap.ProfileIcapHeaderArgs{
			Base64Encoding: pulumi.String("string"),
			Content:        pulumi.String("string"),
			Id:             pulumi.Int(0),
			Name:           pulumi.String("string"),
		},
	},
	Methods:              pulumi.String("string"),
	N204Response:         pulumi.String("string"),
	N204SizeLimit:        pulumi.Int(0),
	Name:                 pulumi.String("string"),
	Preview:              pulumi.String("string"),
	PreviewDataLength:    pulumi.Int(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: icap.ProfileRespmodForwardRuleArray{
		&icap.ProfileRespmodForwardRuleArgs{
			Action: pulumi.String("string"),
			HeaderGroups: icap.ProfileRespmodForwardRuleHeaderGroupArray{
				&icap.ProfileRespmodForwardRuleHeaderGroupArgs{
					CaseSensitivity: pulumi.String("string"),
					Header:          pulumi.String("string"),
					HeaderName:      pulumi.String("string"),
					Id:              pulumi.Int(0),
				},
			},
			Host: pulumi.String("string"),
			HttpRespStatusCodes: icap.ProfileRespmodForwardRuleHttpRespStatusCodeArray{
				&icap.ProfileRespmodForwardRuleHttpRespStatusCodeArgs{
					Code: pulumi.Int(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.Int(0),
	StreamingContentBypass: pulumi.String("string"),
	Timeout:                pulumi.Int(0),
	Vdomparam:              pulumi.String("string"),
})
Copy
var exampleprofileResourceResourceFromIcapprofile = new com.pulumi.fortios.icap.Profile("exampleprofileResourceResourceFromIcapprofile", com.pulumi.fortios.icap.ProfileArgs.builder()
    .chunkEncap("string")
    .comment("string")
    .dynamicSortSubtable("string")
    .extensionFeature("string")
    .fileTransfer("string")
    .fileTransferFailure("string")
    .fileTransferPath("string")
    .fileTransferServer("string")
    .getAllTables("string")
    .icapBlockLog("string")
    .icapHeaders(ProfileIcapHeaderArgs.builder()
        .base64Encoding("string")
        .content("string")
        .id(0)
        .name("string")
        .build())
    .methods("string")
    .n204Response("string")
    .n204SizeLimit(0)
    .name("string")
    .preview("string")
    .previewDataLength(0)
    .replacemsgGroup("string")
    .request("string")
    .requestFailure("string")
    .requestPath("string")
    .requestServer("string")
    .respmodDefaultAction("string")
    .respmodForwardRules(ProfileRespmodForwardRuleArgs.builder()
        .action("string")
        .headerGroups(ProfileRespmodForwardRuleHeaderGroupArgs.builder()
            .caseSensitivity("string")
            .header("string")
            .headerName("string")
            .id(0)
            .build())
        .host("string")
        .httpRespStatusCodes(ProfileRespmodForwardRuleHttpRespStatusCodeArgs.builder()
            .code(0)
            .build())
        .name("string")
        .build())
    .response("string")
    .responseFailure("string")
    .responsePath("string")
    .responseReqHdr("string")
    .responseServer("string")
    .scanProgressInterval(0)
    .streamingContentBypass("string")
    .timeout(0)
    .vdomparam("string")
    .build());
Copy
exampleprofile_resource_resource_from_icapprofile = fortios.icap.Profile("exampleprofileResourceResourceFromIcapprofile",
    chunk_encap="string",
    comment="string",
    dynamic_sort_subtable="string",
    extension_feature="string",
    file_transfer="string",
    file_transfer_failure="string",
    file_transfer_path="string",
    file_transfer_server="string",
    get_all_tables="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",
    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": [{
            "code": 0,
        }],
        "name": "string",
    }],
    response="string",
    response_failure="string",
    response_path="string",
    response_req_hdr="string",
    response_server="string",
    scan_progress_interval=0,
    streaming_content_bypass="string",
    timeout=0,
    vdomparam="string")
Copy
const exampleprofileResourceResourceFromIcapprofile = new fortios.icap.Profile("exampleprofileResourceResourceFromIcapprofile", {
    chunkEncap: "string",
    comment: "string",
    dynamicSortSubtable: "string",
    extensionFeature: "string",
    fileTransfer: "string",
    fileTransferFailure: "string",
    fileTransferPath: "string",
    fileTransferServer: "string",
    getAllTables: "string",
    icapBlockLog: "string",
    icapHeaders: [{
        base64Encoding: "string",
        content: "string",
        id: 0,
        name: "string",
    }],
    methods: "string",
    n204Response: "string",
    n204SizeLimit: 0,
    name: "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: [{
            code: 0,
        }],
        name: "string",
    }],
    response: "string",
    responseFailure: "string",
    responsePath: "string",
    responseReqHdr: "string",
    responseServer: "string",
    scanProgressInterval: 0,
    streamingContentBypass: "string",
    timeout: 0,
    vdomparam: "string",
});
Copy
type: fortios:icap:Profile
properties:
    chunkEncap: string
    comment: string
    dynamicSortSubtable: string
    extensionFeature: string
    fileTransfer: string
    fileTransferFailure: string
    fileTransferPath: string
    fileTransferServer: string
    getAllTables: string
    icapBlockLog: string
    icapHeaders:
        - base64Encoding: string
          content: string
          id: 0
          name: string
    methods: string
    n204Response: string
    n204SizeLimit: 0
    name: 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:
            - code: 0
          name: string
    response: string
    responseFailure: string
    responsePath: string
    responseReqHdr: string
    responseServer: string
    scanProgressInterval: 0
    streamingContentBypass: string
    timeout: 0
    vdomparam: string
Copy

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

ChunkEncap string
Enable/disable chunked encapsulation (default = disable). Valid values: disable, enable.
Comment string
Comment.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
ExtensionFeature string
Enable/disable ICAP extension features. Valid values: scan-progress.
FileTransfer string
Configure the file transfer protocols to pass transferred files to an ICAP server as REQMOD. Valid values: ssh, ftp.
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.
GetAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
IcapBlockLog string
Enable/disable UTM log when infection found (default = disable). Valid values: disable, enable.
IcapHeaders List<Pulumiverse.Fortios.Icap.Inputs.ProfileIcapHeader>
Configure ICAP forwarded request 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.
N204Response string
Enable/disable allowance of 204 response from ICAP server. Valid values: disable, enable.
N204SizeLimit int
204 response size limit to be saved by ICAP client in megabytes (1 - 10, default = 1 MB).
Name Changes to this property will trigger replacement. string
ICAP profile name.
Preview string
Enable/disable preview of data to ICAP server. Valid values: disable, enable.
PreviewDataLength int
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: forward, bypass.
RespmodForwardRules List<Pulumiverse.Fortios.Icap.Inputs.ProfileRespmodForwardRule>
ICAP response mode 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 int
Scan progress interval value.
StreamingContentBypass string
Enable/disable bypassing of ICAP server for streaming content. Valid values: disable, enable.
Timeout int
Time (in seconds) that ICAP client waits for the response from ICAP server.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
ChunkEncap string
Enable/disable chunked encapsulation (default = disable). Valid values: disable, enable.
Comment string
Comment.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
ExtensionFeature string
Enable/disable ICAP extension features. Valid values: scan-progress.
FileTransfer string
Configure the file transfer protocols to pass transferred files to an ICAP server as REQMOD. Valid values: ssh, ftp.
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.
GetAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
IcapBlockLog string
Enable/disable UTM log when infection found (default = disable). Valid values: disable, enable.
IcapHeaders []ProfileIcapHeaderArgs
Configure ICAP forwarded request 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.
N204Response string
Enable/disable allowance of 204 response from ICAP server. Valid values: disable, enable.
N204SizeLimit int
204 response size limit to be saved by ICAP client in megabytes (1 - 10, default = 1 MB).
Name Changes to this property will trigger replacement. string
ICAP profile name.
Preview string
Enable/disable preview of data to ICAP server. Valid values: disable, enable.
PreviewDataLength int
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: forward, bypass.
RespmodForwardRules []ProfileRespmodForwardRuleArgs
ICAP response mode 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 int
Scan progress interval value.
StreamingContentBypass string
Enable/disable bypassing of ICAP server for streaming content. Valid values: disable, enable.
Timeout int
Time (in seconds) that ICAP client waits for the response from ICAP server.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
chunkEncap String
Enable/disable chunked encapsulation (default = disable). Valid values: disable, enable.
comment String
Comment.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
extensionFeature String
Enable/disable ICAP extension features. Valid values: scan-progress.
fileTransfer String
Configure the file transfer protocols to pass transferred files to an ICAP server as REQMOD. Valid values: ssh, ftp.
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.
getAllTables String
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
icapBlockLog String
Enable/disable UTM log when infection found (default = disable). Valid values: disable, enable.
icapHeaders List<ProfileIcapHeader>
Configure ICAP forwarded request 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.
n204Response String
Enable/disable allowance of 204 response from ICAP server. Valid values: disable, enable.
n204SizeLimit Integer
204 response size limit to be saved by ICAP client in megabytes (1 - 10, default = 1 MB).
name Changes to this property will trigger replacement. String
ICAP profile name.
preview String
Enable/disable preview of data to ICAP server. Valid values: disable, enable.
previewDataLength Integer
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: forward, bypass.
respmodForwardRules List<ProfileRespmodForwardRule>
ICAP response mode 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 Integer
Scan progress interval value.
streamingContentBypass String
Enable/disable bypassing of ICAP server for streaming content. Valid values: disable, enable.
timeout Integer
Time (in seconds) that ICAP client waits for the response from ICAP server.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
chunkEncap string
Enable/disable chunked encapsulation (default = disable). Valid values: disable, enable.
comment string
Comment.
dynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
extensionFeature string
Enable/disable ICAP extension features. Valid values: scan-progress.
fileTransfer string
Configure the file transfer protocols to pass transferred files to an ICAP server as REQMOD. Valid values: ssh, ftp.
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.
getAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
icapBlockLog string
Enable/disable UTM log when infection found (default = disable). Valid values: disable, enable.
icapHeaders ProfileIcapHeader[]
Configure ICAP forwarded request 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.
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 Changes to this property will trigger replacement. string
ICAP profile 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: forward, bypass.
respmodForwardRules ProfileRespmodForwardRule[]
ICAP response mode 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.
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.
vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
chunk_encap str
Enable/disable chunked encapsulation (default = disable). Valid values: disable, enable.
comment str
Comment.
dynamic_sort_subtable str
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
extension_feature str
Enable/disable ICAP extension features. Valid values: scan-progress.
file_transfer str
Configure the file transfer protocols to pass transferred files to an ICAP server as REQMOD. Valid values: ssh, ftp.
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.
get_all_tables str
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
icap_block_log str
Enable/disable UTM log when infection found (default = disable). Valid values: disable, enable.
icap_headers Sequence[ProfileIcapHeaderArgs]
Configure ICAP forwarded request headers. The structure of icap_headers block is documented below.
methods str
The allowed HTTP methods that will be sent to ICAP server for further processing.
n204_response str
Enable/disable allowance of 204 response from ICAP server. Valid values: disable, enable.
n204_size_limit int
204 response size limit to be saved by ICAP client in megabytes (1 - 10, default = 1 MB).
name Changes to this property will trigger replacement. str
ICAP profile name.
preview str
Enable/disable preview of data to ICAP server. Valid values: disable, enable.
preview_data_length int
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: forward, bypass.
respmod_forward_rules Sequence[ProfileRespmodForwardRuleArgs]
ICAP response mode 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 int
Scan progress interval value.
streaming_content_bypass str
Enable/disable bypassing of ICAP server for streaming content. Valid values: disable, enable.
timeout int
Time (in seconds) that ICAP client waits for the response from ICAP server.
vdomparam Changes to this property will trigger replacement. str
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
chunkEncap String
Enable/disable chunked encapsulation (default = disable). Valid values: disable, enable.
comment String
Comment.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
extensionFeature String
Enable/disable ICAP extension features. Valid values: scan-progress.
fileTransfer String
Configure the file transfer protocols to pass transferred files to an ICAP server as REQMOD. Valid values: ssh, ftp.
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.
getAllTables String
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
icapBlockLog String
Enable/disable UTM log when infection found (default = disable). Valid values: disable, enable.
icapHeaders List<Property Map>
Configure ICAP forwarded request 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.
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 Changes to this property will trigger replacement. String
ICAP profile 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: forward, bypass.
respmodForwardRules List<Property Map>
ICAP response mode 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.
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.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

Outputs

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

Get an existing Profile 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?: ProfileState, opts?: CustomResourceOptions): Profile
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        chunk_encap: Optional[str] = None,
        comment: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        extension_feature: Optional[str] = None,
        file_transfer: Optional[str] = None,
        file_transfer_failure: Optional[str] = None,
        file_transfer_path: Optional[str] = None,
        file_transfer_server: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        icap_block_log: Optional[str] = None,
        icap_headers: Optional[Sequence[ProfileIcapHeaderArgs]] = None,
        methods: Optional[str] = None,
        n204_response: Optional[str] = None,
        n204_size_limit: Optional[int] = None,
        name: Optional[str] = None,
        preview: Optional[str] = None,
        preview_data_length: Optional[int] = 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[ProfileRespmodForwardRuleArgs]] = 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[int] = None,
        streaming_content_bypass: Optional[str] = None,
        timeout: Optional[int] = None,
        vdomparam: Optional[str] = None) -> Profile
func GetProfile(ctx *Context, name string, id IDInput, state *ProfileState, opts ...ResourceOption) (*Profile, error)
public static Profile Get(string name, Input<string> id, ProfileState? state, CustomResourceOptions? opts = null)
public static Profile get(String name, Output<String> id, ProfileState state, CustomResourceOptions options)
resources:  _:    type: fortios:icap:Profile    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:
ChunkEncap string
Enable/disable chunked encapsulation (default = disable). Valid values: disable, enable.
Comment string
Comment.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
ExtensionFeature string
Enable/disable ICAP extension features. Valid values: scan-progress.
FileTransfer string
Configure the file transfer protocols to pass transferred files to an ICAP server as REQMOD. Valid values: ssh, ftp.
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.
GetAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
IcapBlockLog string
Enable/disable UTM log when infection found (default = disable). Valid values: disable, enable.
IcapHeaders List<Pulumiverse.Fortios.Icap.Inputs.ProfileIcapHeader>
Configure ICAP forwarded request 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.
N204Response string
Enable/disable allowance of 204 response from ICAP server. Valid values: disable, enable.
N204SizeLimit int
204 response size limit to be saved by ICAP client in megabytes (1 - 10, default = 1 MB).
Name Changes to this property will trigger replacement. string
ICAP profile name.
Preview string
Enable/disable preview of data to ICAP server. Valid values: disable, enable.
PreviewDataLength int
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: forward, bypass.
RespmodForwardRules List<Pulumiverse.Fortios.Icap.Inputs.ProfileRespmodForwardRule>
ICAP response mode 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 int
Scan progress interval value.
StreamingContentBypass string
Enable/disable bypassing of ICAP server for streaming content. Valid values: disable, enable.
Timeout int
Time (in seconds) that ICAP client waits for the response from ICAP server.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
ChunkEncap string
Enable/disable chunked encapsulation (default = disable). Valid values: disable, enable.
Comment string
Comment.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
ExtensionFeature string
Enable/disable ICAP extension features. Valid values: scan-progress.
FileTransfer string
Configure the file transfer protocols to pass transferred files to an ICAP server as REQMOD. Valid values: ssh, ftp.
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.
GetAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
IcapBlockLog string
Enable/disable UTM log when infection found (default = disable). Valid values: disable, enable.
IcapHeaders []ProfileIcapHeaderArgs
Configure ICAP forwarded request 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.
N204Response string
Enable/disable allowance of 204 response from ICAP server. Valid values: disable, enable.
N204SizeLimit int
204 response size limit to be saved by ICAP client in megabytes (1 - 10, default = 1 MB).
Name Changes to this property will trigger replacement. string
ICAP profile name.
Preview string
Enable/disable preview of data to ICAP server. Valid values: disable, enable.
PreviewDataLength int
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: forward, bypass.
RespmodForwardRules []ProfileRespmodForwardRuleArgs
ICAP response mode 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 int
Scan progress interval value.
StreamingContentBypass string
Enable/disable bypassing of ICAP server for streaming content. Valid values: disable, enable.
Timeout int
Time (in seconds) that ICAP client waits for the response from ICAP server.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
chunkEncap String
Enable/disable chunked encapsulation (default = disable). Valid values: disable, enable.
comment String
Comment.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
extensionFeature String
Enable/disable ICAP extension features. Valid values: scan-progress.
fileTransfer String
Configure the file transfer protocols to pass transferred files to an ICAP server as REQMOD. Valid values: ssh, ftp.
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.
getAllTables String
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
icapBlockLog String
Enable/disable UTM log when infection found (default = disable). Valid values: disable, enable.
icapHeaders List<ProfileIcapHeader>
Configure ICAP forwarded request 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.
n204Response String
Enable/disable allowance of 204 response from ICAP server. Valid values: disable, enable.
n204SizeLimit Integer
204 response size limit to be saved by ICAP client in megabytes (1 - 10, default = 1 MB).
name Changes to this property will trigger replacement. String
ICAP profile name.
preview String
Enable/disable preview of data to ICAP server. Valid values: disable, enable.
previewDataLength Integer
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: forward, bypass.
respmodForwardRules List<ProfileRespmodForwardRule>
ICAP response mode 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 Integer
Scan progress interval value.
streamingContentBypass String
Enable/disable bypassing of ICAP server for streaming content. Valid values: disable, enable.
timeout Integer
Time (in seconds) that ICAP client waits for the response from ICAP server.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
chunkEncap string
Enable/disable chunked encapsulation (default = disable). Valid values: disable, enable.
comment string
Comment.
dynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
extensionFeature string
Enable/disable ICAP extension features. Valid values: scan-progress.
fileTransfer string
Configure the file transfer protocols to pass transferred files to an ICAP server as REQMOD. Valid values: ssh, ftp.
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.
getAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
icapBlockLog string
Enable/disable UTM log when infection found (default = disable). Valid values: disable, enable.
icapHeaders ProfileIcapHeader[]
Configure ICAP forwarded request 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.
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 Changes to this property will trigger replacement. string
ICAP profile 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: forward, bypass.
respmodForwardRules ProfileRespmodForwardRule[]
ICAP response mode 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.
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.
vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
chunk_encap str
Enable/disable chunked encapsulation (default = disable). Valid values: disable, enable.
comment str
Comment.
dynamic_sort_subtable str
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
extension_feature str
Enable/disable ICAP extension features. Valid values: scan-progress.
file_transfer str
Configure the file transfer protocols to pass transferred files to an ICAP server as REQMOD. Valid values: ssh, ftp.
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.
get_all_tables str
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
icap_block_log str
Enable/disable UTM log when infection found (default = disable). Valid values: disable, enable.
icap_headers Sequence[ProfileIcapHeaderArgs]
Configure ICAP forwarded request headers. The structure of icap_headers block is documented below.
methods str
The allowed HTTP methods that will be sent to ICAP server for further processing.
n204_response str
Enable/disable allowance of 204 response from ICAP server. Valid values: disable, enable.
n204_size_limit int
204 response size limit to be saved by ICAP client in megabytes (1 - 10, default = 1 MB).
name Changes to this property will trigger replacement. str
ICAP profile name.
preview str
Enable/disable preview of data to ICAP server. Valid values: disable, enable.
preview_data_length int
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: forward, bypass.
respmod_forward_rules Sequence[ProfileRespmodForwardRuleArgs]
ICAP response mode 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 int
Scan progress interval value.
streaming_content_bypass str
Enable/disable bypassing of ICAP server for streaming content. Valid values: disable, enable.
timeout int
Time (in seconds) that ICAP client waits for the response from ICAP server.
vdomparam Changes to this property will trigger replacement. str
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
chunkEncap String
Enable/disable chunked encapsulation (default = disable). Valid values: disable, enable.
comment String
Comment.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
extensionFeature String
Enable/disable ICAP extension features. Valid values: scan-progress.
fileTransfer String
Configure the file transfer protocols to pass transferred files to an ICAP server as REQMOD. Valid values: ssh, ftp.
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.
getAllTables String
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
icapBlockLog String
Enable/disable UTM log when infection found (default = disable). Valid values: disable, enable.
icapHeaders List<Property Map>
Configure ICAP forwarded request 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.
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 Changes to this property will trigger replacement. String
ICAP profile 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: forward, bypass.
respmodForwardRules List<Property Map>
ICAP response mode 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.
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.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

Supporting Types

ProfileIcapHeader
, ProfileIcapHeaderArgs

Base64Encoding string
Enable/disable use of base64 encoding of HTTP content. Valid values: disable, enable.
Content string
HTTP header content.
Id int
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 int
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 Integer
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 int
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.

ProfileRespmodForwardRule
, ProfileRespmodForwardRuleArgs

Action string
Action to be taken for ICAP server. Valid values: forward, bypass.
HeaderGroups List<Pulumiverse.Fortios.Icap.Inputs.ProfileRespmodForwardRuleHeaderGroup>
HTTP header group. The structure of header_group block is documented below.
Host string
Address object for the host.
HttpRespStatusCodes List<Pulumiverse.Fortios.Icap.Inputs.ProfileRespmodForwardRuleHttpRespStatusCode>
HTTP response status code. The structure of http_resp_status_code block is documented below.
Name string
Address name.
Action string
Action to be taken for ICAP server. Valid values: forward, bypass.
HeaderGroups []ProfileRespmodForwardRuleHeaderGroup
HTTP header group. The structure of header_group block is documented below.
Host string
Address object for the host.
HttpRespStatusCodes []ProfileRespmodForwardRuleHttpRespStatusCode
HTTP response status code. The structure of http_resp_status_code block is documented below.
Name string
Address name.
action String
Action to be taken for ICAP server. Valid values: forward, bypass.
headerGroups List<ProfileRespmodForwardRuleHeaderGroup>
HTTP header group. The structure of header_group block is documented below.
host String
Address object for the host.
httpRespStatusCodes List<ProfileRespmodForwardRuleHttpRespStatusCode>
HTTP response status code. The structure of http_resp_status_code block is documented below.
name String
Address name.
action string
Action to be taken for ICAP server. Valid values: forward, bypass.
headerGroups ProfileRespmodForwardRuleHeaderGroup[]
HTTP header group. The structure of header_group block is documented below.
host string
Address object for the host.
httpRespStatusCodes ProfileRespmodForwardRuleHttpRespStatusCode[]
HTTP response status code. The structure of http_resp_status_code block is documented below.
name string
Address name.
action str
Action to be taken for ICAP server. Valid values: forward, bypass.
header_groups Sequence[ProfileRespmodForwardRuleHeaderGroup]
HTTP header group. The structure of header_group block is documented below.
host str
Address object for the host.
http_resp_status_codes Sequence[ProfileRespmodForwardRuleHttpRespStatusCode]
HTTP response status code. The structure of http_resp_status_code block is documented below.
name str
Address name.
action String
Action to be taken for ICAP server. Valid values: forward, bypass.
headerGroups List<Property Map>
HTTP header group. The structure of header_group block is documented below.
host String
Address object for the host.
httpRespStatusCodes List<Property Map>
HTTP response status code. The structure of http_resp_status_code block is documented below.
name String
Address name.

ProfileRespmodForwardRuleHeaderGroup
, ProfileRespmodForwardRuleHeaderGroupArgs

CaseSensitivity string
Enable/disable case sensitivity when matching header. Valid values: disable, enable.
Header string
HTTP header regular expression.
HeaderName string
HTTP header.
Id int
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 int
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 Integer
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 int
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.

ProfileRespmodForwardRuleHttpRespStatusCode
, ProfileRespmodForwardRuleHttpRespStatusCodeArgs

Code int
HTTP response status code.
Code int
HTTP response status code.
code Integer
HTTP response status code.
code number
HTTP response status code.
code int
HTTP response status code.
code Number
HTTP response status code.

Import

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

$ pulumi import fortios:icap/profile:Profile labelname {{name}}
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:icap/profile:Profile labelname {{name}}
Copy

$ unset “FORTIOS_IMPORT_TABLE”

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

Package Details

Repository
fortios pulumiverse/pulumi-fortios
License
Apache-2.0
Notes
This Pulumi package is based on the fortios Terraform Provider.