Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Avi Provider
  3. API Docs
  4. Icapprofile
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-avi

avi.Icapprofile

Explore with Pulumi AI

avi 31.1.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-avi

<!–

Copyright 2021 VMware, Inc.
SPDX-License-Identifier: Mozilla Public License 2.0

–>

layout: “avi”

page_title: “Avi: avi.Icapprofile” sidebar_current: “docs-avi-resource-icapprofile” description: |- Creates and manages Avi IcapProfile.

avi.Icapprofile

The IcapProfile resource allows the creation and management of Avi IcapProfile

Example Usage

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

const foo = new avi.Icapprofile("foo", {tenantRef: "/api/tenant/?name=admin"});
Copy
import pulumi
import pulumi_avi as avi

foo = avi.Icapprofile("foo", tenant_ref="/api/tenant/?name=admin")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := avi.NewIcapprofile(ctx, "foo", &avi.IcapprofileArgs{
			TenantRef: pulumi.String("/api/tenant/?name=admin"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Avi = Pulumi.Avi;

return await Deployment.RunAsync(() => 
{
    var foo = new Avi.Icapprofile("foo", new()
    {
        TenantRef = "/api/tenant/?name=admin",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.avi.Icapprofile;
import com.pulumi.avi.IcapprofileArgs;
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 foo = new Icapprofile("foo", IcapprofileArgs.builder()
            .tenantRef("/api/tenant/?name=admin")
            .build());

    }
}
Copy
resources:
  foo:
    type: avi:Icapprofile
    properties:
      tenantRef: /api/tenant/?name=admin
Copy

Create Icapprofile Resource

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

Constructor syntax

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

@overload
def Icapprofile(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                pool_group_ref: Optional[str] = None,
                service_uri: Optional[str] = None,
                icapprofile_id: Optional[str] = None,
                buffer_size_exceed_action: Optional[str] = None,
                configpb_attributes: Optional[Sequence[IcapprofileConfigpbAttributeArgs]] = None,
                description: Optional[str] = None,
                enable_preview: Optional[str] = None,
                fail_action: Optional[str] = None,
                allow204: Optional[str] = None,
                name: Optional[str] = None,
                nsx_defender_configs: Optional[Sequence[IcapprofileNsxDefenderConfigArgs]] = None,
                cloud_ref: Optional[str] = None,
                preview_size: Optional[str] = None,
                response_timeout: Optional[str] = None,
                buffer_size: Optional[str] = None,
                slow_response_warning_threshold: Optional[str] = None,
                tenant_ref: Optional[str] = None,
                uuid: Optional[str] = None,
                vendor: Optional[str] = None)
func NewIcapprofile(ctx *Context, name string, args IcapprofileArgs, opts ...ResourceOption) (*Icapprofile, error)
public Icapprofile(string name, IcapprofileArgs args, CustomResourceOptions? opts = null)
public Icapprofile(String name, IcapprofileArgs args)
public Icapprofile(String name, IcapprofileArgs args, CustomResourceOptions options)

type: avi:Icapprofile
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 This property is required. IcapprofileArgs
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 This property is required. IcapprofileArgs
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 This property is required. IcapprofileArgs
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 This property is required. IcapprofileArgs
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. IcapprofileArgs
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 icapprofileResource = new Avi.Icapprofile("icapprofileResource", new()
{
    PoolGroupRef = "string",
    ServiceUri = "string",
    IcapprofileId = "string",
    BufferSizeExceedAction = "string",
    ConfigpbAttributes = new[]
    {
        new Avi.Inputs.IcapprofileConfigpbAttributeArgs
        {
            Version = "string",
        },
    },
    Description = "string",
    EnablePreview = "string",
    FailAction = "string",
    Allow204 = "string",
    Name = "string",
    NsxDefenderConfigs = new[]
    {
        new Avi.Inputs.IcapprofileNsxDefenderConfigArgs
        {
            StatusUrl = "string",
        },
    },
    CloudRef = "string",
    PreviewSize = "string",
    ResponseTimeout = "string",
    BufferSize = "string",
    SlowResponseWarningThreshold = "string",
    TenantRef = "string",
    Uuid = "string",
    Vendor = "string",
});
Copy
example, err := avi.NewIcapprofile(ctx, "icapprofileResource", &avi.IcapprofileArgs{
PoolGroupRef: pulumi.String("string"),
ServiceUri: pulumi.String("string"),
IcapprofileId: pulumi.String("string"),
BufferSizeExceedAction: pulumi.String("string"),
ConfigpbAttributes: .IcapprofileConfigpbAttributeArray{
&.IcapprofileConfigpbAttributeArgs{
Version: pulumi.String("string"),
},
},
Description: pulumi.String("string"),
EnablePreview: pulumi.String("string"),
FailAction: pulumi.String("string"),
Allow204: pulumi.String("string"),
Name: pulumi.String("string"),
NsxDefenderConfigs: .IcapprofileNsxDefenderConfigArray{
&.IcapprofileNsxDefenderConfigArgs{
StatusUrl: pulumi.String("string"),
},
},
CloudRef: pulumi.String("string"),
PreviewSize: pulumi.String("string"),
ResponseTimeout: pulumi.String("string"),
BufferSize: pulumi.String("string"),
SlowResponseWarningThreshold: pulumi.String("string"),
TenantRef: pulumi.String("string"),
Uuid: pulumi.String("string"),
Vendor: pulumi.String("string"),
})
Copy
var icapprofileResource = new Icapprofile("icapprofileResource", IcapprofileArgs.builder()
    .poolGroupRef("string")
    .serviceUri("string")
    .icapprofileId("string")
    .bufferSizeExceedAction("string")
    .configpbAttributes(IcapprofileConfigpbAttributeArgs.builder()
        .version("string")
        .build())
    .description("string")
    .enablePreview("string")
    .failAction("string")
    .allow204("string")
    .name("string")
    .nsxDefenderConfigs(IcapprofileNsxDefenderConfigArgs.builder()
        .statusUrl("string")
        .build())
    .cloudRef("string")
    .previewSize("string")
    .responseTimeout("string")
    .bufferSize("string")
    .slowResponseWarningThreshold("string")
    .tenantRef("string")
    .uuid("string")
    .vendor("string")
    .build());
Copy
icapprofile_resource = avi.Icapprofile("icapprofileResource",
    pool_group_ref="string",
    service_uri="string",
    icapprofile_id="string",
    buffer_size_exceed_action="string",
    configpb_attributes=[{
        "version": "string",
    }],
    description="string",
    enable_preview="string",
    fail_action="string",
    allow204="string",
    name="string",
    nsx_defender_configs=[{
        "status_url": "string",
    }],
    cloud_ref="string",
    preview_size="string",
    response_timeout="string",
    buffer_size="string",
    slow_response_warning_threshold="string",
    tenant_ref="string",
    uuid="string",
    vendor="string")
Copy
const icapprofileResource = new avi.Icapprofile("icapprofileResource", {
    poolGroupRef: "string",
    serviceUri: "string",
    icapprofileId: "string",
    bufferSizeExceedAction: "string",
    configpbAttributes: [{
        version: "string",
    }],
    description: "string",
    enablePreview: "string",
    failAction: "string",
    allow204: "string",
    name: "string",
    nsxDefenderConfigs: [{
        statusUrl: "string",
    }],
    cloudRef: "string",
    previewSize: "string",
    responseTimeout: "string",
    bufferSize: "string",
    slowResponseWarningThreshold: "string",
    tenantRef: "string",
    uuid: "string",
    vendor: "string",
});
Copy
type: avi:Icapprofile
properties:
    allow204: string
    bufferSize: string
    bufferSizeExceedAction: string
    cloudRef: string
    configpbAttributes:
        - version: string
    description: string
    enablePreview: string
    failAction: string
    icapprofileId: string
    name: string
    nsxDefenderConfigs:
        - statusUrl: string
    poolGroupRef: string
    previewSize: string
    responseTimeout: string
    serviceUri: string
    slowResponseWarningThreshold: string
    tenantRef: string
    uuid: string
    vendor: string
Copy

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

PoolGroupRef This property is required. string
The pool group which is used to connect to icap servers. It is a reference to an object of type poolgroup. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ServiceUri This property is required. string
The path and query component of the icap url. Host name and port will be taken from the pool. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Allow204 string
Allow icap server to send 204 response as described in rfc 3507 section 4.5. Service engine will buffer the complete request if alllow_204 is enabled. If disabled, preview_size request body will be buffered if enable_preview is set to true, and rest of the request body will be streamed to the icap server. Field introduced in 20.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
BufferSize string
The maximum buffer size for the http request body. If the request body exceeds this size, the request will not be checked by the icap server. In this case, the configured action will be executed and a significant log entry will be generated. Allowed values are 1-51200. Field introduced in 20.1.1. Unit is kb. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
BufferSizeExceedAction string
Decide what should happen if the request body size exceeds the configured buffer size. If this is set to fail open, the request will not be checked by the icap server. If this is set to fail closed, the request will be rejected with 413 status code. Enum options - ICAP_FAIL_OPEN, ICAP_FAIL_CLOSED. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
CloudRef string
The cloud where this object belongs to. This must match the cloud referenced in the pool group below. It is a reference to an object of type cloud. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfigpbAttributes List<IcapprofileConfigpbAttribute>
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Description string
A description for this icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
EnablePreview string
Use the icap preview feature as described in rfc 3507 section 4.5. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
FailAction string
Decide what should happen if there is a problem with the icap server like communication timeout, protocol error, pool error, etc. If the icap server responds with 4xx-5xx error code the configured fail action is performed. If this is set to fail open, the request will continue, but will create a significant log entry. If this is set to fail closed, the request will be rejected with a 500 status code. Enum options - ICAP_FAIL_OPEN, ICAP_FAIL_CLOSED. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
IcapprofileId string
Name string
Name of the icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
NsxDefenderConfigs List<IcapprofileNsxDefenderConfig>
Nsxdefender specific icap configurations. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
PreviewSize string
The icap preview size as described in rfc 3507 section 4.5. This should not exceed the size supported by the icap server. If this is set to 0, only the http header will be sent to the icap server as a preview. To disable preview completely, set the enable-preview option to false.if vendor is lastline, recommended preview size is 1000 bytes,minimum preview size is 10 bytes. Allowed values are 0-5000. Field introduced in 20.1.1. Unit is bytes. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ResponseTimeout string
Maximum time, client's request will be paused for icap processing. If this timeout is exceeded, the request to the icap server will be aborted and the configured fail action is executed. Allowed values are 50-3600000. Field introduced in 20.1.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
SlowResponseWarningThreshold string
If the icap request takes longer than this value, this request will generate a significant log entry. Allowed values are 50-3600000. Field introduced in 20.1.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TenantRef string
Tenant which this object belongs to. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string
Uuid of the icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Vendor string
The vendor of the icap server. Enum options - ICAP_VENDOR_GENERIC, ICAP_VENDOR_OPSWAT, ICAP_VENDOR_LASTLINE. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
PoolGroupRef This property is required. string
The pool group which is used to connect to icap servers. It is a reference to an object of type poolgroup. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ServiceUri This property is required. string
The path and query component of the icap url. Host name and port will be taken from the pool. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Allow204 string
Allow icap server to send 204 response as described in rfc 3507 section 4.5. Service engine will buffer the complete request if alllow_204 is enabled. If disabled, preview_size request body will be buffered if enable_preview is set to true, and rest of the request body will be streamed to the icap server. Field introduced in 20.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
BufferSize string
The maximum buffer size for the http request body. If the request body exceeds this size, the request will not be checked by the icap server. In this case, the configured action will be executed and a significant log entry will be generated. Allowed values are 1-51200. Field introduced in 20.1.1. Unit is kb. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
BufferSizeExceedAction string
Decide what should happen if the request body size exceeds the configured buffer size. If this is set to fail open, the request will not be checked by the icap server. If this is set to fail closed, the request will be rejected with 413 status code. Enum options - ICAP_FAIL_OPEN, ICAP_FAIL_CLOSED. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
CloudRef string
The cloud where this object belongs to. This must match the cloud referenced in the pool group below. It is a reference to an object of type cloud. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfigpbAttributes []IcapprofileConfigpbAttributeArgs
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Description string
A description for this icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
EnablePreview string
Use the icap preview feature as described in rfc 3507 section 4.5. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
FailAction string
Decide what should happen if there is a problem with the icap server like communication timeout, protocol error, pool error, etc. If the icap server responds with 4xx-5xx error code the configured fail action is performed. If this is set to fail open, the request will continue, but will create a significant log entry. If this is set to fail closed, the request will be rejected with a 500 status code. Enum options - ICAP_FAIL_OPEN, ICAP_FAIL_CLOSED. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
IcapprofileId string
Name string
Name of the icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
NsxDefenderConfigs []IcapprofileNsxDefenderConfigArgs
Nsxdefender specific icap configurations. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
PreviewSize string
The icap preview size as described in rfc 3507 section 4.5. This should not exceed the size supported by the icap server. If this is set to 0, only the http header will be sent to the icap server as a preview. To disable preview completely, set the enable-preview option to false.if vendor is lastline, recommended preview size is 1000 bytes,minimum preview size is 10 bytes. Allowed values are 0-5000. Field introduced in 20.1.1. Unit is bytes. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ResponseTimeout string
Maximum time, client's request will be paused for icap processing. If this timeout is exceeded, the request to the icap server will be aborted and the configured fail action is executed. Allowed values are 50-3600000. Field introduced in 20.1.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
SlowResponseWarningThreshold string
If the icap request takes longer than this value, this request will generate a significant log entry. Allowed values are 50-3600000. Field introduced in 20.1.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TenantRef string
Tenant which this object belongs to. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string
Uuid of the icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Vendor string
The vendor of the icap server. Enum options - ICAP_VENDOR_GENERIC, ICAP_VENDOR_OPSWAT, ICAP_VENDOR_LASTLINE. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
poolGroupRef This property is required. String
The pool group which is used to connect to icap servers. It is a reference to an object of type poolgroup. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
serviceUri This property is required. String
The path and query component of the icap url. Host name and port will be taken from the pool. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
allow204 String
Allow icap server to send 204 response as described in rfc 3507 section 4.5. Service engine will buffer the complete request if alllow_204 is enabled. If disabled, preview_size request body will be buffered if enable_preview is set to true, and rest of the request body will be streamed to the icap server. Field introduced in 20.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
bufferSize String
The maximum buffer size for the http request body. If the request body exceeds this size, the request will not be checked by the icap server. In this case, the configured action will be executed and a significant log entry will be generated. Allowed values are 1-51200. Field introduced in 20.1.1. Unit is kb. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
bufferSizeExceedAction String
Decide what should happen if the request body size exceeds the configured buffer size. If this is set to fail open, the request will not be checked by the icap server. If this is set to fail closed, the request will be rejected with 413 status code. Enum options - ICAP_FAIL_OPEN, ICAP_FAIL_CLOSED. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
cloudRef String
The cloud where this object belongs to. This must match the cloud referenced in the pool group below. It is a reference to an object of type cloud. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes List<IcapprofileConfigpbAttribute>
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description String
A description for this icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
enablePreview String
Use the icap preview feature as described in rfc 3507 section 4.5. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
failAction String
Decide what should happen if there is a problem with the icap server like communication timeout, protocol error, pool error, etc. If the icap server responds with 4xx-5xx error code the configured fail action is performed. If this is set to fail open, the request will continue, but will create a significant log entry. If this is set to fail closed, the request will be rejected with a 500 status code. Enum options - ICAP_FAIL_OPEN, ICAP_FAIL_CLOSED. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
icapprofileId String
name String
Name of the icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
nsxDefenderConfigs List<IcapprofileNsxDefenderConfig>
Nsxdefender specific icap configurations. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
previewSize String
The icap preview size as described in rfc 3507 section 4.5. This should not exceed the size supported by the icap server. If this is set to 0, only the http header will be sent to the icap server as a preview. To disable preview completely, set the enable-preview option to false.if vendor is lastline, recommended preview size is 1000 bytes,minimum preview size is 10 bytes. Allowed values are 0-5000. Field introduced in 20.1.1. Unit is bytes. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
responseTimeout String
Maximum time, client's request will be paused for icap processing. If this timeout is exceeded, the request to the icap server will be aborted and the configured fail action is executed. Allowed values are 50-3600000. Field introduced in 20.1.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
slowResponseWarningThreshold String
If the icap request takes longer than this value, this request will generate a significant log entry. Allowed values are 50-3600000. Field introduced in 20.1.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef String
Tenant which this object belongs to. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String
Uuid of the icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
vendor String
The vendor of the icap server. Enum options - ICAP_VENDOR_GENERIC, ICAP_VENDOR_OPSWAT, ICAP_VENDOR_LASTLINE. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
poolGroupRef This property is required. string
The pool group which is used to connect to icap servers. It is a reference to an object of type poolgroup. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
serviceUri This property is required. string
The path and query component of the icap url. Host name and port will be taken from the pool. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
allow204 string
Allow icap server to send 204 response as described in rfc 3507 section 4.5. Service engine will buffer the complete request if alllow_204 is enabled. If disabled, preview_size request body will be buffered if enable_preview is set to true, and rest of the request body will be streamed to the icap server. Field introduced in 20.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
bufferSize string
The maximum buffer size for the http request body. If the request body exceeds this size, the request will not be checked by the icap server. In this case, the configured action will be executed and a significant log entry will be generated. Allowed values are 1-51200. Field introduced in 20.1.1. Unit is kb. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
bufferSizeExceedAction string
Decide what should happen if the request body size exceeds the configured buffer size. If this is set to fail open, the request will not be checked by the icap server. If this is set to fail closed, the request will be rejected with 413 status code. Enum options - ICAP_FAIL_OPEN, ICAP_FAIL_CLOSED. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
cloudRef string
The cloud where this object belongs to. This must match the cloud referenced in the pool group below. It is a reference to an object of type cloud. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes IcapprofileConfigpbAttribute[]
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description string
A description for this icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
enablePreview string
Use the icap preview feature as described in rfc 3507 section 4.5. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
failAction string
Decide what should happen if there is a problem with the icap server like communication timeout, protocol error, pool error, etc. If the icap server responds with 4xx-5xx error code the configured fail action is performed. If this is set to fail open, the request will continue, but will create a significant log entry. If this is set to fail closed, the request will be rejected with a 500 status code. Enum options - ICAP_FAIL_OPEN, ICAP_FAIL_CLOSED. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
icapprofileId string
name string
Name of the icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
nsxDefenderConfigs IcapprofileNsxDefenderConfig[]
Nsxdefender specific icap configurations. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
previewSize string
The icap preview size as described in rfc 3507 section 4.5. This should not exceed the size supported by the icap server. If this is set to 0, only the http header will be sent to the icap server as a preview. To disable preview completely, set the enable-preview option to false.if vendor is lastline, recommended preview size is 1000 bytes,minimum preview size is 10 bytes. Allowed values are 0-5000. Field introduced in 20.1.1. Unit is bytes. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
responseTimeout string
Maximum time, client's request will be paused for icap processing. If this timeout is exceeded, the request to the icap server will be aborted and the configured fail action is executed. Allowed values are 50-3600000. Field introduced in 20.1.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
slowResponseWarningThreshold string
If the icap request takes longer than this value, this request will generate a significant log entry. Allowed values are 50-3600000. Field introduced in 20.1.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef string
Tenant which this object belongs to. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid string
Uuid of the icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
vendor string
The vendor of the icap server. Enum options - ICAP_VENDOR_GENERIC, ICAP_VENDOR_OPSWAT, ICAP_VENDOR_LASTLINE. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
pool_group_ref This property is required. str
The pool group which is used to connect to icap servers. It is a reference to an object of type poolgroup. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
service_uri This property is required. str
The path and query component of the icap url. Host name and port will be taken from the pool. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
allow204 str
Allow icap server to send 204 response as described in rfc 3507 section 4.5. Service engine will buffer the complete request if alllow_204 is enabled. If disabled, preview_size request body will be buffered if enable_preview is set to true, and rest of the request body will be streamed to the icap server. Field introduced in 20.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
buffer_size str
The maximum buffer size for the http request body. If the request body exceeds this size, the request will not be checked by the icap server. In this case, the configured action will be executed and a significant log entry will be generated. Allowed values are 1-51200. Field introduced in 20.1.1. Unit is kb. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
buffer_size_exceed_action str
Decide what should happen if the request body size exceeds the configured buffer size. If this is set to fail open, the request will not be checked by the icap server. If this is set to fail closed, the request will be rejected with 413 status code. Enum options - ICAP_FAIL_OPEN, ICAP_FAIL_CLOSED. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
cloud_ref str
The cloud where this object belongs to. This must match the cloud referenced in the pool group below. It is a reference to an object of type cloud. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpb_attributes Sequence[IcapprofileConfigpbAttributeArgs]
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description str
A description for this icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
enable_preview str
Use the icap preview feature as described in rfc 3507 section 4.5. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
fail_action str
Decide what should happen if there is a problem with the icap server like communication timeout, protocol error, pool error, etc. If the icap server responds with 4xx-5xx error code the configured fail action is performed. If this is set to fail open, the request will continue, but will create a significant log entry. If this is set to fail closed, the request will be rejected with a 500 status code. Enum options - ICAP_FAIL_OPEN, ICAP_FAIL_CLOSED. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
icapprofile_id str
name str
Name of the icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
nsx_defender_configs Sequence[IcapprofileNsxDefenderConfigArgs]
Nsxdefender specific icap configurations. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
preview_size str
The icap preview size as described in rfc 3507 section 4.5. This should not exceed the size supported by the icap server. If this is set to 0, only the http header will be sent to the icap server as a preview. To disable preview completely, set the enable-preview option to false.if vendor is lastline, recommended preview size is 1000 bytes,minimum preview size is 10 bytes. Allowed values are 0-5000. Field introduced in 20.1.1. Unit is bytes. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
response_timeout str
Maximum time, client's request will be paused for icap processing. If this timeout is exceeded, the request to the icap server will be aborted and the configured fail action is executed. Allowed values are 50-3600000. Field introduced in 20.1.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
slow_response_warning_threshold str
If the icap request takes longer than this value, this request will generate a significant log entry. Allowed values are 50-3600000. Field introduced in 20.1.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenant_ref str
Tenant which this object belongs to. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid str
Uuid of the icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
vendor str
The vendor of the icap server. Enum options - ICAP_VENDOR_GENERIC, ICAP_VENDOR_OPSWAT, ICAP_VENDOR_LASTLINE. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
poolGroupRef This property is required. String
The pool group which is used to connect to icap servers. It is a reference to an object of type poolgroup. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
serviceUri This property is required. String
The path and query component of the icap url. Host name and port will be taken from the pool. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
allow204 String
Allow icap server to send 204 response as described in rfc 3507 section 4.5. Service engine will buffer the complete request if alllow_204 is enabled. If disabled, preview_size request body will be buffered if enable_preview is set to true, and rest of the request body will be streamed to the icap server. Field introduced in 20.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
bufferSize String
The maximum buffer size for the http request body. If the request body exceeds this size, the request will not be checked by the icap server. In this case, the configured action will be executed and a significant log entry will be generated. Allowed values are 1-51200. Field introduced in 20.1.1. Unit is kb. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
bufferSizeExceedAction String
Decide what should happen if the request body size exceeds the configured buffer size. If this is set to fail open, the request will not be checked by the icap server. If this is set to fail closed, the request will be rejected with 413 status code. Enum options - ICAP_FAIL_OPEN, ICAP_FAIL_CLOSED. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
cloudRef String
The cloud where this object belongs to. This must match the cloud referenced in the pool group below. It is a reference to an object of type cloud. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes List<Property Map>
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description String
A description for this icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
enablePreview String
Use the icap preview feature as described in rfc 3507 section 4.5. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
failAction String
Decide what should happen if there is a problem with the icap server like communication timeout, protocol error, pool error, etc. If the icap server responds with 4xx-5xx error code the configured fail action is performed. If this is set to fail open, the request will continue, but will create a significant log entry. If this is set to fail closed, the request will be rejected with a 500 status code. Enum options - ICAP_FAIL_OPEN, ICAP_FAIL_CLOSED. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
icapprofileId String
name String
Name of the icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
nsxDefenderConfigs List<Property Map>
Nsxdefender specific icap configurations. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
previewSize String
The icap preview size as described in rfc 3507 section 4.5. This should not exceed the size supported by the icap server. If this is set to 0, only the http header will be sent to the icap server as a preview. To disable preview completely, set the enable-preview option to false.if vendor is lastline, recommended preview size is 1000 bytes,minimum preview size is 10 bytes. Allowed values are 0-5000. Field introduced in 20.1.1. Unit is bytes. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
responseTimeout String
Maximum time, client's request will be paused for icap processing. If this timeout is exceeded, the request to the icap server will be aborted and the configured fail action is executed. Allowed values are 50-3600000. Field introduced in 20.1.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
slowResponseWarningThreshold String
If the icap request takes longer than this value, this request will generate a significant log entry. Allowed values are 50-3600000. Field introduced in 20.1.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef String
Tenant which this object belongs to. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String
Uuid of the icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
vendor String
The vendor of the icap server. Enum options - ICAP_VENDOR_GENERIC, ICAP_VENDOR_OPSWAT, ICAP_VENDOR_LASTLINE. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

Outputs

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

Get an existing Icapprofile 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?: IcapprofileState, opts?: CustomResourceOptions): Icapprofile
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allow204: Optional[str] = None,
        buffer_size: Optional[str] = None,
        buffer_size_exceed_action: Optional[str] = None,
        cloud_ref: Optional[str] = None,
        configpb_attributes: Optional[Sequence[IcapprofileConfigpbAttributeArgs]] = None,
        description: Optional[str] = None,
        enable_preview: Optional[str] = None,
        fail_action: Optional[str] = None,
        icapprofile_id: Optional[str] = None,
        name: Optional[str] = None,
        nsx_defender_configs: Optional[Sequence[IcapprofileNsxDefenderConfigArgs]] = None,
        pool_group_ref: Optional[str] = None,
        preview_size: Optional[str] = None,
        response_timeout: Optional[str] = None,
        service_uri: Optional[str] = None,
        slow_response_warning_threshold: Optional[str] = None,
        tenant_ref: Optional[str] = None,
        uuid: Optional[str] = None,
        vendor: Optional[str] = None) -> Icapprofile
func GetIcapprofile(ctx *Context, name string, id IDInput, state *IcapprofileState, opts ...ResourceOption) (*Icapprofile, error)
public static Icapprofile Get(string name, Input<string> id, IcapprofileState? state, CustomResourceOptions? opts = null)
public static Icapprofile get(String name, Output<String> id, IcapprofileState state, CustomResourceOptions options)
resources:  _:    type: avi:Icapprofile    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:
Allow204 string
Allow icap server to send 204 response as described in rfc 3507 section 4.5. Service engine will buffer the complete request if alllow_204 is enabled. If disabled, preview_size request body will be buffered if enable_preview is set to true, and rest of the request body will be streamed to the icap server. Field introduced in 20.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
BufferSize string
The maximum buffer size for the http request body. If the request body exceeds this size, the request will not be checked by the icap server. In this case, the configured action will be executed and a significant log entry will be generated. Allowed values are 1-51200. Field introduced in 20.1.1. Unit is kb. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
BufferSizeExceedAction string
Decide what should happen if the request body size exceeds the configured buffer size. If this is set to fail open, the request will not be checked by the icap server. If this is set to fail closed, the request will be rejected with 413 status code. Enum options - ICAP_FAIL_OPEN, ICAP_FAIL_CLOSED. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
CloudRef string
The cloud where this object belongs to. This must match the cloud referenced in the pool group below. It is a reference to an object of type cloud. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfigpbAttributes List<IcapprofileConfigpbAttribute>
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Description string
A description for this icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
EnablePreview string
Use the icap preview feature as described in rfc 3507 section 4.5. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
FailAction string
Decide what should happen if there is a problem with the icap server like communication timeout, protocol error, pool error, etc. If the icap server responds with 4xx-5xx error code the configured fail action is performed. If this is set to fail open, the request will continue, but will create a significant log entry. If this is set to fail closed, the request will be rejected with a 500 status code. Enum options - ICAP_FAIL_OPEN, ICAP_FAIL_CLOSED. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
IcapprofileId string
Name string
Name of the icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
NsxDefenderConfigs List<IcapprofileNsxDefenderConfig>
Nsxdefender specific icap configurations. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
PoolGroupRef string
The pool group which is used to connect to icap servers. It is a reference to an object of type poolgroup. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
PreviewSize string
The icap preview size as described in rfc 3507 section 4.5. This should not exceed the size supported by the icap server. If this is set to 0, only the http header will be sent to the icap server as a preview. To disable preview completely, set the enable-preview option to false.if vendor is lastline, recommended preview size is 1000 bytes,minimum preview size is 10 bytes. Allowed values are 0-5000. Field introduced in 20.1.1. Unit is bytes. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ResponseTimeout string
Maximum time, client's request will be paused for icap processing. If this timeout is exceeded, the request to the icap server will be aborted and the configured fail action is executed. Allowed values are 50-3600000. Field introduced in 20.1.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ServiceUri string
The path and query component of the icap url. Host name and port will be taken from the pool. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
SlowResponseWarningThreshold string
If the icap request takes longer than this value, this request will generate a significant log entry. Allowed values are 50-3600000. Field introduced in 20.1.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TenantRef string
Tenant which this object belongs to. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string
Uuid of the icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Vendor string
The vendor of the icap server. Enum options - ICAP_VENDOR_GENERIC, ICAP_VENDOR_OPSWAT, ICAP_VENDOR_LASTLINE. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Allow204 string
Allow icap server to send 204 response as described in rfc 3507 section 4.5. Service engine will buffer the complete request if alllow_204 is enabled. If disabled, preview_size request body will be buffered if enable_preview is set to true, and rest of the request body will be streamed to the icap server. Field introduced in 20.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
BufferSize string
The maximum buffer size for the http request body. If the request body exceeds this size, the request will not be checked by the icap server. In this case, the configured action will be executed and a significant log entry will be generated. Allowed values are 1-51200. Field introduced in 20.1.1. Unit is kb. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
BufferSizeExceedAction string
Decide what should happen if the request body size exceeds the configured buffer size. If this is set to fail open, the request will not be checked by the icap server. If this is set to fail closed, the request will be rejected with 413 status code. Enum options - ICAP_FAIL_OPEN, ICAP_FAIL_CLOSED. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
CloudRef string
The cloud where this object belongs to. This must match the cloud referenced in the pool group below. It is a reference to an object of type cloud. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfigpbAttributes []IcapprofileConfigpbAttributeArgs
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Description string
A description for this icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
EnablePreview string
Use the icap preview feature as described in rfc 3507 section 4.5. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
FailAction string
Decide what should happen if there is a problem with the icap server like communication timeout, protocol error, pool error, etc. If the icap server responds with 4xx-5xx error code the configured fail action is performed. If this is set to fail open, the request will continue, but will create a significant log entry. If this is set to fail closed, the request will be rejected with a 500 status code. Enum options - ICAP_FAIL_OPEN, ICAP_FAIL_CLOSED. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
IcapprofileId string
Name string
Name of the icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
NsxDefenderConfigs []IcapprofileNsxDefenderConfigArgs
Nsxdefender specific icap configurations. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
PoolGroupRef string
The pool group which is used to connect to icap servers. It is a reference to an object of type poolgroup. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
PreviewSize string
The icap preview size as described in rfc 3507 section 4.5. This should not exceed the size supported by the icap server. If this is set to 0, only the http header will be sent to the icap server as a preview. To disable preview completely, set the enable-preview option to false.if vendor is lastline, recommended preview size is 1000 bytes,minimum preview size is 10 bytes. Allowed values are 0-5000. Field introduced in 20.1.1. Unit is bytes. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ResponseTimeout string
Maximum time, client's request will be paused for icap processing. If this timeout is exceeded, the request to the icap server will be aborted and the configured fail action is executed. Allowed values are 50-3600000. Field introduced in 20.1.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ServiceUri string
The path and query component of the icap url. Host name and port will be taken from the pool. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
SlowResponseWarningThreshold string
If the icap request takes longer than this value, this request will generate a significant log entry. Allowed values are 50-3600000. Field introduced in 20.1.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TenantRef string
Tenant which this object belongs to. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string
Uuid of the icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Vendor string
The vendor of the icap server. Enum options - ICAP_VENDOR_GENERIC, ICAP_VENDOR_OPSWAT, ICAP_VENDOR_LASTLINE. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
allow204 String
Allow icap server to send 204 response as described in rfc 3507 section 4.5. Service engine will buffer the complete request if alllow_204 is enabled. If disabled, preview_size request body will be buffered if enable_preview is set to true, and rest of the request body will be streamed to the icap server. Field introduced in 20.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
bufferSize String
The maximum buffer size for the http request body. If the request body exceeds this size, the request will not be checked by the icap server. In this case, the configured action will be executed and a significant log entry will be generated. Allowed values are 1-51200. Field introduced in 20.1.1. Unit is kb. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
bufferSizeExceedAction String
Decide what should happen if the request body size exceeds the configured buffer size. If this is set to fail open, the request will not be checked by the icap server. If this is set to fail closed, the request will be rejected with 413 status code. Enum options - ICAP_FAIL_OPEN, ICAP_FAIL_CLOSED. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
cloudRef String
The cloud where this object belongs to. This must match the cloud referenced in the pool group below. It is a reference to an object of type cloud. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes List<IcapprofileConfigpbAttribute>
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description String
A description for this icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
enablePreview String
Use the icap preview feature as described in rfc 3507 section 4.5. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
failAction String
Decide what should happen if there is a problem with the icap server like communication timeout, protocol error, pool error, etc. If the icap server responds with 4xx-5xx error code the configured fail action is performed. If this is set to fail open, the request will continue, but will create a significant log entry. If this is set to fail closed, the request will be rejected with a 500 status code. Enum options - ICAP_FAIL_OPEN, ICAP_FAIL_CLOSED. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
icapprofileId String
name String
Name of the icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
nsxDefenderConfigs List<IcapprofileNsxDefenderConfig>
Nsxdefender specific icap configurations. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
poolGroupRef String
The pool group which is used to connect to icap servers. It is a reference to an object of type poolgroup. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
previewSize String
The icap preview size as described in rfc 3507 section 4.5. This should not exceed the size supported by the icap server. If this is set to 0, only the http header will be sent to the icap server as a preview. To disable preview completely, set the enable-preview option to false.if vendor is lastline, recommended preview size is 1000 bytes,minimum preview size is 10 bytes. Allowed values are 0-5000. Field introduced in 20.1.1. Unit is bytes. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
responseTimeout String
Maximum time, client's request will be paused for icap processing. If this timeout is exceeded, the request to the icap server will be aborted and the configured fail action is executed. Allowed values are 50-3600000. Field introduced in 20.1.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
serviceUri String
The path and query component of the icap url. Host name and port will be taken from the pool. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
slowResponseWarningThreshold String
If the icap request takes longer than this value, this request will generate a significant log entry. Allowed values are 50-3600000. Field introduced in 20.1.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef String
Tenant which this object belongs to. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String
Uuid of the icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
vendor String
The vendor of the icap server. Enum options - ICAP_VENDOR_GENERIC, ICAP_VENDOR_OPSWAT, ICAP_VENDOR_LASTLINE. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
allow204 string
Allow icap server to send 204 response as described in rfc 3507 section 4.5. Service engine will buffer the complete request if alllow_204 is enabled. If disabled, preview_size request body will be buffered if enable_preview is set to true, and rest of the request body will be streamed to the icap server. Field introduced in 20.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
bufferSize string
The maximum buffer size for the http request body. If the request body exceeds this size, the request will not be checked by the icap server. In this case, the configured action will be executed and a significant log entry will be generated. Allowed values are 1-51200. Field introduced in 20.1.1. Unit is kb. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
bufferSizeExceedAction string
Decide what should happen if the request body size exceeds the configured buffer size. If this is set to fail open, the request will not be checked by the icap server. If this is set to fail closed, the request will be rejected with 413 status code. Enum options - ICAP_FAIL_OPEN, ICAP_FAIL_CLOSED. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
cloudRef string
The cloud where this object belongs to. This must match the cloud referenced in the pool group below. It is a reference to an object of type cloud. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes IcapprofileConfigpbAttribute[]
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description string
A description for this icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
enablePreview string
Use the icap preview feature as described in rfc 3507 section 4.5. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
failAction string
Decide what should happen if there is a problem with the icap server like communication timeout, protocol error, pool error, etc. If the icap server responds with 4xx-5xx error code the configured fail action is performed. If this is set to fail open, the request will continue, but will create a significant log entry. If this is set to fail closed, the request will be rejected with a 500 status code. Enum options - ICAP_FAIL_OPEN, ICAP_FAIL_CLOSED. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
icapprofileId string
name string
Name of the icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
nsxDefenderConfigs IcapprofileNsxDefenderConfig[]
Nsxdefender specific icap configurations. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
poolGroupRef string
The pool group which is used to connect to icap servers. It is a reference to an object of type poolgroup. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
previewSize string
The icap preview size as described in rfc 3507 section 4.5. This should not exceed the size supported by the icap server. If this is set to 0, only the http header will be sent to the icap server as a preview. To disable preview completely, set the enable-preview option to false.if vendor is lastline, recommended preview size is 1000 bytes,minimum preview size is 10 bytes. Allowed values are 0-5000. Field introduced in 20.1.1. Unit is bytes. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
responseTimeout string
Maximum time, client's request will be paused for icap processing. If this timeout is exceeded, the request to the icap server will be aborted and the configured fail action is executed. Allowed values are 50-3600000. Field introduced in 20.1.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
serviceUri string
The path and query component of the icap url. Host name and port will be taken from the pool. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
slowResponseWarningThreshold string
If the icap request takes longer than this value, this request will generate a significant log entry. Allowed values are 50-3600000. Field introduced in 20.1.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef string
Tenant which this object belongs to. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid string
Uuid of the icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
vendor string
The vendor of the icap server. Enum options - ICAP_VENDOR_GENERIC, ICAP_VENDOR_OPSWAT, ICAP_VENDOR_LASTLINE. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
allow204 str
Allow icap server to send 204 response as described in rfc 3507 section 4.5. Service engine will buffer the complete request if alllow_204 is enabled. If disabled, preview_size request body will be buffered if enable_preview is set to true, and rest of the request body will be streamed to the icap server. Field introduced in 20.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
buffer_size str
The maximum buffer size for the http request body. If the request body exceeds this size, the request will not be checked by the icap server. In this case, the configured action will be executed and a significant log entry will be generated. Allowed values are 1-51200. Field introduced in 20.1.1. Unit is kb. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
buffer_size_exceed_action str
Decide what should happen if the request body size exceeds the configured buffer size. If this is set to fail open, the request will not be checked by the icap server. If this is set to fail closed, the request will be rejected with 413 status code. Enum options - ICAP_FAIL_OPEN, ICAP_FAIL_CLOSED. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
cloud_ref str
The cloud where this object belongs to. This must match the cloud referenced in the pool group below. It is a reference to an object of type cloud. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpb_attributes Sequence[IcapprofileConfigpbAttributeArgs]
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description str
A description for this icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
enable_preview str
Use the icap preview feature as described in rfc 3507 section 4.5. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
fail_action str
Decide what should happen if there is a problem with the icap server like communication timeout, protocol error, pool error, etc. If the icap server responds with 4xx-5xx error code the configured fail action is performed. If this is set to fail open, the request will continue, but will create a significant log entry. If this is set to fail closed, the request will be rejected with a 500 status code. Enum options - ICAP_FAIL_OPEN, ICAP_FAIL_CLOSED. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
icapprofile_id str
name str
Name of the icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
nsx_defender_configs Sequence[IcapprofileNsxDefenderConfigArgs]
Nsxdefender specific icap configurations. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
pool_group_ref str
The pool group which is used to connect to icap servers. It is a reference to an object of type poolgroup. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
preview_size str
The icap preview size as described in rfc 3507 section 4.5. This should not exceed the size supported by the icap server. If this is set to 0, only the http header will be sent to the icap server as a preview. To disable preview completely, set the enable-preview option to false.if vendor is lastline, recommended preview size is 1000 bytes,minimum preview size is 10 bytes. Allowed values are 0-5000. Field introduced in 20.1.1. Unit is bytes. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
response_timeout str
Maximum time, client's request will be paused for icap processing. If this timeout is exceeded, the request to the icap server will be aborted and the configured fail action is executed. Allowed values are 50-3600000. Field introduced in 20.1.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
service_uri str
The path and query component of the icap url. Host name and port will be taken from the pool. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
slow_response_warning_threshold str
If the icap request takes longer than this value, this request will generate a significant log entry. Allowed values are 50-3600000. Field introduced in 20.1.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenant_ref str
Tenant which this object belongs to. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid str
Uuid of the icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
vendor str
The vendor of the icap server. Enum options - ICAP_VENDOR_GENERIC, ICAP_VENDOR_OPSWAT, ICAP_VENDOR_LASTLINE. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
allow204 String
Allow icap server to send 204 response as described in rfc 3507 section 4.5. Service engine will buffer the complete request if alllow_204 is enabled. If disabled, preview_size request body will be buffered if enable_preview is set to true, and rest of the request body will be streamed to the icap server. Field introduced in 20.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
bufferSize String
The maximum buffer size for the http request body. If the request body exceeds this size, the request will not be checked by the icap server. In this case, the configured action will be executed and a significant log entry will be generated. Allowed values are 1-51200. Field introduced in 20.1.1. Unit is kb. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
bufferSizeExceedAction String
Decide what should happen if the request body size exceeds the configured buffer size. If this is set to fail open, the request will not be checked by the icap server. If this is set to fail closed, the request will be rejected with 413 status code. Enum options - ICAP_FAIL_OPEN, ICAP_FAIL_CLOSED. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
cloudRef String
The cloud where this object belongs to. This must match the cloud referenced in the pool group below. It is a reference to an object of type cloud. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes List<Property Map>
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description String
A description for this icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
enablePreview String
Use the icap preview feature as described in rfc 3507 section 4.5. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
failAction String
Decide what should happen if there is a problem with the icap server like communication timeout, protocol error, pool error, etc. If the icap server responds with 4xx-5xx error code the configured fail action is performed. If this is set to fail open, the request will continue, but will create a significant log entry. If this is set to fail closed, the request will be rejected with a 500 status code. Enum options - ICAP_FAIL_OPEN, ICAP_FAIL_CLOSED. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
icapprofileId String
name String
Name of the icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
nsxDefenderConfigs List<Property Map>
Nsxdefender specific icap configurations. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
poolGroupRef String
The pool group which is used to connect to icap servers. It is a reference to an object of type poolgroup. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
previewSize String
The icap preview size as described in rfc 3507 section 4.5. This should not exceed the size supported by the icap server. If this is set to 0, only the http header will be sent to the icap server as a preview. To disable preview completely, set the enable-preview option to false.if vendor is lastline, recommended preview size is 1000 bytes,minimum preview size is 10 bytes. Allowed values are 0-5000. Field introduced in 20.1.1. Unit is bytes. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
responseTimeout String
Maximum time, client's request will be paused for icap processing. If this timeout is exceeded, the request to the icap server will be aborted and the configured fail action is executed. Allowed values are 50-3600000. Field introduced in 20.1.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
serviceUri String
The path and query component of the icap url. Host name and port will be taken from the pool. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
slowResponseWarningThreshold String
If the icap request takes longer than this value, this request will generate a significant log entry. Allowed values are 50-3600000. Field introduced in 20.1.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef String
Tenant which this object belongs to. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String
Uuid of the icap profile. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
vendor String
The vendor of the icap server. Enum options - ICAP_VENDOR_GENERIC, ICAP_VENDOR_OPSWAT, ICAP_VENDOR_LASTLINE. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

Supporting Types

IcapprofileConfigpbAttribute
, IcapprofileConfigpbAttributeArgs

Version string
Version string
version String
version string
version String

IcapprofileNsxDefenderConfig
, IcapprofileNsxDefenderConfigArgs

StatusUrl string
StatusUrl string
statusUrl String
statusUrl string
statusUrl String

Package Details

Repository
avi vmware/terraform-provider-avi
License
Notes
This Pulumi package is based on the avi Terraform Provider.
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-avi