Parameter |
Choices/Defaults |
Comments |
api_context
(added in 2.5) |
|
Avi API context that includes current session ID and CSRF Token.
This allows user to perform single login and re-use the session.
|
api_version
|
Default:
16.4.4
|
Avi API version of to use for Avi API and objects.
|
avi_api_patch_op
(added in 2.5) |
Choices:
- add
- replace
- delete
|
Patch operation to use when using avi_api_update_method as patch.
|
avi_api_update_method
(added in 2.5) |
|
Default method for object update is HTTP PUT.
Setting to patch will override that behavior to use HTTP PATCH.
|
avi_credentials
(added in 2.5) |
|
Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.
|
controller
|
Default:
|
IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER .
|
description
|
|
User defined description for the object.
|
dns_service_profile
|
|
Specifies various dns service related controls for virtual service.
|
dos_rl_profile
|
|
Specifies various security related controls for virtual service.
|
http_profile
|
|
Specifies the http application proxy profile parameters.
|
name
required |
|
The name of the application profile.
|
password
|
Default:
|
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD .
|
preserve_client_ip
bool |
|
Specifies if client ip needs to be preserved for backend connection.
Not compatible with connection multiplexing.
Default value when not specified in API or module is interpreted by Avi Controller as False.
|
preserve_client_port
bool
(added in 2.6) |
|
Specifies if we need to preserve client port while preseving client ip for backend connections.
Field introduced in 17.2.7.
Default value when not specified in API or module is interpreted by Avi Controller as False.
|
state
|
Choices:
- absent
present ←
|
The state that should be applied on the entity.
|
tcp_app_profile
|
|
Specifies the tcp application proxy profile parameters.
|
tenant
|
Default:
admin
|
Name of tenant used for all Avi API calls and context of object.
|
tenant_ref
|
|
It is a reference to an object of type tenant.
|
tenant_uuid
|
Default:
|
UUID of tenant used for all Avi API calls and context of object.
|
type
required |
|
Specifies which application layer proxy is enabled for the virtual service.
Enum options - APPLICATION_PROFILE_TYPE_L4, APPLICATION_PROFILE_TYPE_HTTP, APPLICATION_PROFILE_TYPE_SYSLOG, APPLICATION_PROFILE_TYPE_DNS,
APPLICATION_PROFILE_TYPE_SSL.
|
url
|
|
Avi controller URL of the object.
|
username
|
Default:
|
Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME .
|
uuid
|
|
Uuid of the application profile.
|