Docs Home
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware
avi.Icapprofile
Explore with Pulumi AI
<!–
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"});
import pulumi
import pulumi_avi as avi
foo = avi.Icapprofile("foo", tenant_ref="/api/tenant/?name=admin")
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
})
}
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",
});
});
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());
}
}
resources:
foo:
type: avi:Icapprofile
properties:
tenantRef: /api/tenant/?name=admin
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 string
- The unique name of the resource.
- args IcapprofileArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args IcapprofileArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IcapprofileArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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",
});
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: avi.IcapprofileConfigpbAttributeArray{
&avi.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: avi.IcapprofileNsxDefenderConfigArray{
&avi.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"),
})
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());
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")
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",
});
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
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:
- Pool
Group stringRef - 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 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.
- Buffer
Size 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.
- Buffer
Size stringExceed Action - 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 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.
- Configpb
Attributes List<IcapprofileConfigpb Attribute> - 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.
- Enable
Preview 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.
- Fail
Action 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.
- Icapprofile
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.
- Nsx
Defender List<IcapprofileConfigs Nsx Defender Config> - Nsxdefender specific icap configurations. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
- Preview
Size 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.
- Response
Timeout 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.
- Slow
Response stringWarning Threshold - 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 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 stringRef - 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 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.
- Buffer
Size 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.
- Buffer
Size stringExceed Action - 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 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.
- Configpb
Attributes []IcapprofileConfigpb Attribute Args - 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.
- Enable
Preview 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.
- Fail
Action 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.
- Icapprofile
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.
- Nsx
Defender []IcapprofileConfigs Nsx Defender Config Args - Nsxdefender specific icap configurations. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
- Preview
Size 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.
- Response
Timeout 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.
- Slow
Response stringWarning Threshold - 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 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 StringRef - 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 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.
- buffer
Size 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.
- buffer
Size StringExceed Action - 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 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.
- configpb
Attributes List<IcapprofileConfigpb Attribute> - 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.
- enable
Preview 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.
- fail
Action 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.
- icapprofile
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.
- nsx
Defender List<IcapprofileConfigs Nsx Defender Config> - Nsxdefender specific icap configurations. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
- preview
Size 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.
- response
Timeout 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.
- slow
Response StringWarning Threshold - 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 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 stringRef - 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 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.
- buffer
Size 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.
- buffer
Size stringExceed Action - 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 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.
- configpb
Attributes IcapprofileConfigpb Attribute[] - 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.
- enable
Preview 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.
- fail
Action 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.
- icapprofile
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.
- nsx
Defender IcapprofileConfigs Nsx Defender Config[] - Nsxdefender specific icap configurations. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
- preview
Size 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.
- response
Timeout 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.
- slow
Response stringWarning Threshold - 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 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_ strref - 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 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_ strexceed_ action - 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[IcapprofileConfigpb Attribute Args] - 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_ Sequence[Icapprofileconfigs Nsx Defender Config Args] - 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_ strwarning_ threshold - 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.
- pool
Group StringRef - 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 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.
- buffer
Size 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.
- buffer
Size StringExceed Action - 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 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.
- configpb
Attributes 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.
- enable
Preview 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.
- fail
Action 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.
- icapprofile
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.
- nsx
Defender List<Property Map>Configs - Nsxdefender specific icap configurations. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
- preview
Size 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.
- response
Timeout 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.
- slow
Response StringWarning Threshold - 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 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) -> Icapprofilefunc 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- 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.
- Buffer
Size 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.
- Buffer
Size stringExceed Action - 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 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.
- Configpb
Attributes List<IcapprofileConfigpb Attribute> - 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.
- Enable
Preview 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.
- Fail
Action 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.
- Icapprofile
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.
- Nsx
Defender List<IcapprofileConfigs Nsx Defender Config> - Nsxdefender specific icap configurations. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
- Pool
Group stringRef - 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 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.
- Response
Timeout 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.
- Service
Uri 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.
- Slow
Response stringWarning Threshold - 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 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.
- Buffer
Size 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.
- Buffer
Size stringExceed Action - 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 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.
- Configpb
Attributes []IcapprofileConfigpb Attribute Args - 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.
- Enable
Preview 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.
- Fail
Action 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.
- Icapprofile
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.
- Nsx
Defender []IcapprofileConfigs Nsx Defender Config Args - Nsxdefender specific icap configurations. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
- Pool
Group stringRef - 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 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.
- Response
Timeout 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.
- Service
Uri 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.
- Slow
Response stringWarning Threshold - 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 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.
- buffer
Size 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.
- buffer
Size StringExceed Action - 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 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.
- configpb
Attributes List<IcapprofileConfigpb Attribute> - 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.
- enable
Preview 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.
- fail
Action 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.
- icapprofile
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.
- nsx
Defender List<IcapprofileConfigs Nsx Defender Config> - Nsxdefender specific icap configurations. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
- pool
Group StringRef - 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 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.
- response
Timeout 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.
- service
Uri 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.
- slow
Response StringWarning Threshold - 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 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.
- buffer
Size 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.
- buffer
Size stringExceed Action - 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 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.
- configpb
Attributes IcapprofileConfigpb Attribute[] - 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.
- enable
Preview 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.
- fail
Action 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.
- icapprofile
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.
- nsx
Defender IcapprofileConfigs Nsx Defender Config[] - Nsxdefender specific icap configurations. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
- pool
Group stringRef - 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 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.
- response
Timeout 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.
- service
Uri 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.
- slow
Response stringWarning Threshold - 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 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_ strexceed_ action - 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[IcapprofileConfigpb Attribute Args] - 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_ Sequence[Icapprofileconfigs Nsx Defender Config Args] - Nsxdefender specific icap configurations. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
- pool_
group_ strref - 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_ strwarning_ threshold - 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.
- buffer
Size 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.
- buffer
Size StringExceed Action - 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 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.
- configpb
Attributes 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.
- enable
Preview 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.
- fail
Action 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.
- icapprofile
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.
- nsx
Defender List<Property Map>Configs - Nsxdefender specific icap configurations. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
- pool
Group StringRef - 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 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.
- response
Timeout 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.
- service
Uri 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.
- slow
Response StringWarning Threshold - 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 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 str
- version String
IcapprofileNsxDefenderConfig, IcapprofileNsxDefenderConfigArgs
- Status
Url string
- Status
Url string
- status
Url String
- status
Url string
- status_
url str
- status
Url String
Package Details
- Repository
- avi vmware/terraform-provider-avi
- License
- Notes
- This Pulumi package is based on the
aviTerraform Provider.