Documentation

avi_applicationprofile - Module for setup of ApplicationProfile Avi RESTful Object

New in version 2.3.

Synopsis

Options

parameter required default choices comments
controller
no
IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.
description
no
User defined description for the object.
dns_service_profile
no
Specifies various dns service related controls for virtual service.
dos_rl_profile
no
Specifies various security related controls for virtual service.
http_profile
no
Specifies the http application proxy profile parameters.
name
yes
The name of the application profile.
password
no
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.
preserve_client_ip
no
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.
state
no present
  • absent
  • present
The state that should be applied on the entity.
tcp_app_profile
no
Specifies the tcp application proxy profile parameters.
tenant
no admin
Name of tenant used for all Avi API calls and context of object.
tenant_ref
no
It is a reference to an object of type tenant.
tenant_uuid
no
UUID of tenant used for all Avi API calls and context of object.
type
yes
Specifies which application layer proxy is enabled for the virtual service.
url
no
Avi controller URL of the object.
username
no
Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME.
uuid
no
Uuid of the application profile.

Examples

- name: Create an Application Profile for HTTP application enabled for SSL traffic
  avi_applicationprofile:
    controller: ''
    username: ''
    password: ''
    http_profile:
      cache_config:
        age_header: true
        aggressive: false
        date_header: true
        default_expire: 600
        enabled: false
        heuristic_expire: false
        max_cache_size: 0
        max_object_size: 4194304
        mime_types_group_refs:
        - admin:System-Cacheable-Resource-Types
        min_object_size: 100
        query_cacheable: false
        xcache_header: true
      client_body_timeout: 0
      client_header_timeout: 10000
      client_max_body_size: 0
      client_max_header_size: 12
      client_max_request_size: 48
      compression_profile:
        compressible_content_ref: admin:System-Compressible-Content-Types
        compression: false
        remove_accept_encoding_header: true
        type: AUTO_COMPRESSION
      connection_multiplexing_enabled: true
      hsts_enabled: false
      hsts_max_age: 365
      http_to_https: false
      httponly_enabled: false
      keepalive_header: false
      keepalive_timeout: 30000
      max_bad_rps_cip: 0
      max_bad_rps_cip_uri: 0
      max_bad_rps_uri: 0
      max_rps_cip: 0
      max_rps_cip_uri: 0
      max_rps_unknown_cip: 0
      max_rps_unknown_uri: 0
      max_rps_uri: 0
      post_accept_timeout: 30000
      secure_cookie_enabled: false
      server_side_redirect_to_https: false
      spdy_enabled: false
      spdy_fwd_proxy_mode: false
      ssl_client_certificate_mode: SSL_CLIENT_CERTIFICATE_NONE
      ssl_everywhere_enabled: false
      websockets_enabled: true
      x_forwarded_proto_enabled: false
      xff_alternate_name: X-Forwarded-For
      xff_enabled: true
    name: System-HTTP
    tenant_ref: admin
    type: APPLICATION_PROFILE_TYPE_HTTP

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
obj ApplicationProfile (api/applicationprofile) object success, changed dict


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.