avi.getIcapprofile

Explore with Pulumi AI

avi 31.1.1 published on Monday, Apr 14, 2025 by vmware

<!–

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

–>

layout: “avi”

page_title: “AVI: avi.Icapprofile” sidebar_current: “docs-avi-datasource-icapprofile” description: |- Get information of Avi IcapProfile.

avi.Icapprofile

This data source is used to to get avi.Icapprofile objects.

Example Usage

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

const fooIcapprofile = avi.getIcapprofile({
    cloudRef: "/api/cloud/?tenant=admin&name=Default-Cloud",
    name: "foo",
    uuid: "icapprofile-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
});

import pulumi
import pulumi_avi as avi

foo_icapprofile = avi.get_icapprofile(cloud_ref="/api/cloud/?tenant=admin&name=Default-Cloud",
    name="foo",
    uuid="icapprofile-f9cf6b3e-a411-436f-95e2-2982ba2b217b")

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.LookupIcapprofile(ctx, &avi.LookupIcapprofileArgs{
			CloudRef: pulumi.StringRef("/api/cloud/?tenant=admin&name=Default-Cloud"),
			Name:     pulumi.StringRef("foo"),
			Uuid:     pulumi.StringRef("icapprofile-f9cf6b3e-a411-436f-95e2-2982ba2b217b"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Avi = Pulumi.Avi;

return await Deployment.RunAsync(() => 
{
    var fooIcapprofile = Avi.GetIcapprofile.Invoke(new()
    {
        CloudRef = "/api/cloud/?tenant=admin&name=Default-Cloud",
        Name = "foo",
        Uuid = "icapprofile-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.avi.AviFunctions;
import com.pulumi.avi.inputs.GetIcapprofileArgs;
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) {
        final var fooIcapprofile = AviFunctions.getIcapprofile(GetIcapprofileArgs.builder()
            .cloudRef("/api/cloud/?tenant=admin&name=Default-Cloud")
            .name("foo")
            .uuid("icapprofile-f9cf6b3e-a411-436f-95e2-2982ba2b217b")
            .build());

    }
}

variables:
  fooIcapprofile:
    fn::invoke:
      function: avi:getIcapprofile
      arguments:
        cloudRef: /api/cloud/?tenant=admin&name=Default-Cloud
        name: foo
        uuid: icapprofile-f9cf6b3e-a411-436f-95e2-2982ba2b217b

Using getIcapprofile

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getIcapprofile(args: GetIcapprofileArgs, opts?: InvokeOptions): Promise<GetIcapprofileResult>
function getIcapprofileOutput(args: GetIcapprofileOutputArgs, opts?: InvokeOptions): Output<GetIcapprofileResult>

def get_icapprofile(cloud_ref: Optional[str] = None,
                    id: Optional[str] = None,
                    name: Optional[str] = None,
                    tenant_ref: Optional[str] = None,
                    uuid: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetIcapprofileResult
def get_icapprofile_output(cloud_ref: Optional[pulumi.Input[str]] = None,
                    id: Optional[pulumi.Input[str]] = None,
                    name: Optional[pulumi.Input[str]] = None,
                    tenant_ref: Optional[pulumi.Input[str]] = None,
                    uuid: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetIcapprofileResult]

func LookupIcapprofile(ctx *Context, args *LookupIcapprofileArgs, opts ...InvokeOption) (*LookupIcapprofileResult, error)
func LookupIcapprofileOutput(ctx *Context, args *LookupIcapprofileOutputArgs, opts ...InvokeOption) LookupIcapprofileResultOutput

> Note: This function is named LookupIcapprofile in the Go SDK.

public static class GetIcapprofile 
{
    public static Task<GetIcapprofileResult> InvokeAsync(GetIcapprofileArgs args, InvokeOptions? opts = null)
    public static Output<GetIcapprofileResult> Invoke(GetIcapprofileInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetIcapprofileResult> getIcapprofile(GetIcapprofileArgs args, InvokeOptions options)
public static Output<GetIcapprofileResult> getIcapprofile(GetIcapprofileArgs args, InvokeOptions options)

fn::invoke:
  function: avi:index/getIcapprofile:getIcapprofile
  arguments:
    # arguments dictionary

The following arguments are supported:

CloudRef string: Search IcapProfile by cloud_ref.
Id string
Name string: Search IcapProfile by name.
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: Search IcapProfile by uuid.

CloudRef string: Search IcapProfile by cloud_ref.
Id string
Name string: Search IcapProfile by name.
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: Search IcapProfile by uuid.

cloudRef String: Search IcapProfile by cloud_ref.
id String
name String: Search IcapProfile by name.
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: Search IcapProfile by uuid.

cloudRef string: Search IcapProfile by cloud_ref.
id string
name string: Search IcapProfile by name.
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: Search IcapProfile by uuid.

cloud_ref str: Search IcapProfile by cloud_ref.
id str
name str: Search IcapProfile by name.
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: Search IcapProfile by uuid.

cloudRef String: Search IcapProfile by cloud_ref.
id String
name String: Search IcapProfile by name.
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: Search IcapProfile by uuid.

getIcapprofile Result

The following output properties are available:

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<GetIcapprofileConfigpbAttribute>: 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.
Id 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<GetIcapprofileNsxDefenderConfig>: 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 []GetIcapprofileConfigpbAttribute: 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.
Id 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 []GetIcapprofileNsxDefenderConfig: 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<GetIcapprofileConfigpbAttribute>: 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.
id 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<GetIcapprofileNsxDefenderConfig>: 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 GetIcapprofileConfigpbAttribute[]: 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.
id 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 GetIcapprofileNsxDefenderConfig[]: 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[GetIcapprofileConfigpbAttribute]: 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.
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[GetIcapprofileNsxDefenderConfig]: 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.
id 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.