Skip to content

Latest commit

 

History

History
730 lines (710 loc) · 32.4 KB

avi_icapprofile.rst

File metadata and controls

730 lines (710 loc) · 32.4 KB

vmware.alb.avi_icapprofile

Module for setup of IcapProfile Avi RESTful Object

Synopsis

Parameters

Parameter Choices/Defaults Comments
state
str
  • absent
  • present ←
- The state that should be applied on the entity.
avi_api_update_method
str
  • put ←
  • patch
- Default method for object update is HTTP PUT.
- Setting to patch will override that behavior to use HTTP PATCH.
avi_api_patch_op
str
  • add ←
  • replace
  • delete
  • remove
- Patch operation to use when using avi_api_update_method as patch.
avi_patch_path
str
- Patch path to use when using avi_api_update_method as patch.
avi_patch_value
str
- Patch value to use when using avi_api_update_method as patch.
allow_204
bool
- 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 in enterprise edition with any value, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as True.
buffer_size
int
- 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 in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 51200.
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 in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as ICAP_FAIL_OPEN.
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 in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
configpb_attributes
dict
- Protobuf versioning for config pbs.
- Field introduced in 21.1.1.
- Allowed in enterprise edition with any value, essentials edition with any value, basic edition with any value, enterprise with cloud services
- edition.
description
str
- A description for this icap profile.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
enable_preview
bool
- Use the icap preview feature as described in rfc 3507 section 4.5.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as True.
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 in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as ICAP_FAIL_OPEN.
name
str
required: true
- Name of the icap profile.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
nsx_defender_config
dict
- Nsxdefender specific icap configurations.
- Field introduced in 21.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
pool_group_ref
str
required: true
- 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 in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
preview_size
int
- 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 in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 5000.
response_timeout
int
- 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 in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 60000.
service_uri
str
required: true
- 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 in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
slow_response_warning_threshold
int
- 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 in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 10000.
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 in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
url
str
- Avi controller URL of the object.
uuid
str
- Uuid of the icap profile.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, 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 in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as ICAP_VENDOR_OPSWAT.

Examples

- hosts: localhost
  connection: local
  collections:
    - vmware.alb
  vars:
    avi_credentials:
      username: "avi_user"
      password: "avi_password"
      controller: "192.168.138.18"
      api_version: "21.1.1"
  tasks:
    - name: Example to create IcapProfile object
      avi_icapprofile:
        avi_credentials: "{{ avi_credentials }}"
        state: present
        name: sample_icapprofile

Authors