Skip to content

Latest commit

 

History

History
680 lines (659 loc) · 29 KB

avi_applicationprofile.rst

File metadata and controls

680 lines (659 loc) · 29 KB

vmware.alb.avi_applicationprofile

Module for setup of ApplicationProfile 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.
app_service_type
str
- Specifies app service type for an application.
- Enum options - APP_SERVICE_TYPE_L7_HORIZON, APP_SERVICE_TYPE_L4_BLAST, APP_SERVICE_TYPE_L4_PCOIP, APP_SERVICE_TYPE_L4_FTP.
- Field introduced in 21.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
cloud_config_cksum
str
- Checksum of application profiles.
- Internally set by cloud connector.
- Field introduced in 17.2.14, 18.1.5, 18.2.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.
created_by
str
- Name of the application profile creator.
- Field introduced in 17.2.14, 18.1.5, 18.2.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
description
str
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
dns_service_profile
dict
- Specifies various dns service related controls for virtual service.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
dos_rl_profile
dict
- Specifies various security related controls for virtual service.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
http_profile
dict
- Specifies the http application proxy profile parameters.
- Allowed in enterprise edition with any value, basic, enterprise with cloud services edition.
l4_ssl_profile
dict
- Specifies various l4 ssl service related controls for virtual service.
- Field introduced in 22.1.2.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
markers
list
- List of labels to be used for granular rbac.
- Field introduced in 20.1.5.
- Allowed in enterprise edition with any value, essentials edition with any value, basic edition with any value, enterprise with cloud services
- edition.
name
str
required: true
- The name of the application profile.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
preserve_client_ip
bool
- Specifies if client ip needs to be preserved for backend connection.
- Not compatible with connection multiplexing.
- 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 False.
preserve_client_port
bool
- Specifies if we need to preserve client port while preserving client ip for backend connections.
- Field introduced in 17.2.7.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
preserve_dest_ip_port
bool
- Specifies if destination ip and port needs to be preserved for backend connection.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials edition(allowed values- false), basic edition(allowed values- false), enterprise with
- cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
sip_service_profile
dict
- Specifies various sip service related controls for virtual service.
- Field introduced in 17.2.8, 18.1.3, 18.2.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
tcp_app_profile
dict
- Specifies the tcp application proxy profile parameters.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
tenant_ref
str
- It is a reference to an object of type tenant.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
type
str
required: true
- 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, APPLICATION_PROFILE_TYPE_SIP.
- Allowed in enterprise edition with any value, essentials edition(allowed values- application_profile_type_l4), basic edition(allowed values-
- application_profile_type_l4,application_profile_type_http), enterprise with cloud services edition.
url
str
- Avi controller URL of the object.
uuid
str
- Uuid of the application profile.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.

Examples

- hosts: localhost
  connection: local
  collections:
    - vmware.alb
  vars:
    avi_credentials:
      username: "{{ username }}"
      password: "{{ password }}"
      controller: "{{ controller }}"
      api_version: "{{ api_version }}"
  tasks:
    - name: Create an Application Profile for HTTP application enabled for SSL traffic
      avi_applicationprofile:
        avi_credentials: "{{ avi_credentials }}"
        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: /api/tenant?name=admin
        type: APPLICATION_PROFILE_TYPE_HTTP

Authors