Avi ApplicationPersistenceProfile Object API

##CLI## ``` - configure applicationpersistenceprofile - show applicationpersistenceprofile ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 17.2.4
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /applicationpersistenceprofile
  2. post /applicationpersistenceprofile
  3. delete /applicationpersistenceprofile/{uuid}
  4. get /applicationpersistenceprofile/{uuid}/federated_info/
  5. get /applicationpersistenceprofile/{uuid}
  6. patch /applicationpersistenceprofile/{uuid}
  7. put /applicationpersistenceprofile/{uuid}
Up
get /applicationpersistenceprofile
( applicationpersistenceprofileGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

ApplicationPersistenceProfileApiResponse

Example data

Content-Type: application/json
{
  "count" : 123,
  "results" : [ {
    "hdr_persistence_profile" : {
      "prst_hdr_name" : "aeiou"
    },
    "http_cookie_persistence_profile" : {
      "encryption_key" : "aeiou",
      "always_send_cookie" : true,
      "key" : [ {
        "hmac_key" : "aeiou",
        "aes_key" : "aeiou",
        "name" : "aeiou"
      } ],
      "timeout" : 123,
      "cookie_name" : "aeiou"
    },
    "ip_persistence_profile" : {
      "ip_persistent_timeout" : 123
    },
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "server_hm_down_recovery" : "aeiou",
    "description" : "aeiou",
    "persistence_type" : "aeiou",
    "uuid" : "aeiou",
    "app_cookie_persistence_profile" : {
      "prst_hdr_name" : "aeiou",
      "encryption_key" : "aeiou",
      "timeout" : 123
    },
    "is_federated" : true,
    "url" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ApplicationPersistenceProfileApiResponse

401

log in failed

Up
post /applicationpersistenceprofile
( applicationpersistenceprofilePost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — ApplicationPersistenceProfile object creation

Return type

ApplicationPersistenceProfile

Example data

Content-Type: application/json
{
  "hdr_persistence_profile" : {
    "prst_hdr_name" : "aeiou"
  },
  "http_cookie_persistence_profile" : {
    "encryption_key" : "aeiou",
    "always_send_cookie" : true,
    "key" : [ {
      "hmac_key" : "aeiou",
      "aes_key" : "aeiou",
      "name" : "aeiou"
    } ],
    "timeout" : 123,
    "cookie_name" : "aeiou"
  },
  "ip_persistence_profile" : {
    "ip_persistent_timeout" : 123
  },
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "server_hm_down_recovery" : "aeiou",
  "description" : "aeiou",
  "persistence_type" : "aeiou",
  "uuid" : "aeiou",
  "app_cookie_persistence_profile" : {
    "prst_hdr_name" : "aeiou",
    "encryption_key" : "aeiou",
    "timeout" : 123
  },
  "is_federated" : true,
  "url" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ApplicationPersistenceProfile

401

log in failed

Up
delete /applicationpersistenceprofile/{uuid}
( applicationpersistenceprofileUuidDelete)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

object deleted String

404

not found

Up
get /applicationpersistenceprofile/{uuid}/federated_info/
( applicationpersistenceprofileUuidFederatedInfoGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

401

log in failed

Up
get /applicationpersistenceprofile/{uuid}
( applicationpersistenceprofileUuidGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

ApplicationPersistenceProfile

Example data

Content-Type: application/json
{
  "hdr_persistence_profile" : {
    "prst_hdr_name" : "aeiou"
  },
  "http_cookie_persistence_profile" : {
    "encryption_key" : "aeiou",
    "always_send_cookie" : true,
    "key" : [ {
      "hmac_key" : "aeiou",
      "aes_key" : "aeiou",
      "name" : "aeiou"
    } ],
    "timeout" : 123,
    "cookie_name" : "aeiou"
  },
  "ip_persistence_profile" : {
    "ip_persistent_timeout" : 123
  },
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "server_hm_down_recovery" : "aeiou",
  "description" : "aeiou",
  "persistence_type" : "aeiou",
  "uuid" : "aeiou",
  "app_cookie_persistence_profile" : {
    "prst_hdr_name" : "aeiou",
    "encryption_key" : "aeiou",
    "timeout" : 123
  },
  "is_federated" : true,
  "url" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ApplicationPersistenceProfile

401

log in failed

Up
patch /applicationpersistenceprofile/{uuid}
( applicationpersistenceprofileUuidPatch)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — ApplicationPersistenceProfile object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

ApplicationPersistenceProfile

Example data

Content-Type: application/json
{
  "hdr_persistence_profile" : {
    "prst_hdr_name" : "aeiou"
  },
  "http_cookie_persistence_profile" : {
    "encryption_key" : "aeiou",
    "always_send_cookie" : true,
    "key" : [ {
      "hmac_key" : "aeiou",
      "aes_key" : "aeiou",
      "name" : "aeiou"
    } ],
    "timeout" : 123,
    "cookie_name" : "aeiou"
  },
  "ip_persistence_profile" : {
    "ip_persistent_timeout" : 123
  },
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "server_hm_down_recovery" : "aeiou",
  "description" : "aeiou",
  "persistence_type" : "aeiou",
  "uuid" : "aeiou",
  "app_cookie_persistence_profile" : {
    "prst_hdr_name" : "aeiou",
    "encryption_key" : "aeiou",
    "timeout" : 123
  },
  "is_federated" : true,
  "url" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ApplicationPersistenceProfile

401

log in failed

Up
put /applicationpersistenceprofile/{uuid}
( applicationpersistenceprofileUuidPut)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — ApplicationPersistenceProfile object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

ApplicationPersistenceProfile

Example data

Content-Type: application/json
{
  "hdr_persistence_profile" : {
    "prst_hdr_name" : "aeiou"
  },
  "http_cookie_persistence_profile" : {
    "encryption_key" : "aeiou",
    "always_send_cookie" : true,
    "key" : [ {
      "hmac_key" : "aeiou",
      "aes_key" : "aeiou",
      "name" : "aeiou"
    } ],
    "timeout" : 123,
    "cookie_name" : "aeiou"
  },
  "ip_persistence_profile" : {
    "ip_persistent_timeout" : 123
  },
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "server_hm_down_recovery" : "aeiou",
  "description" : "aeiou",
  "persistence_type" : "aeiou",
  "uuid" : "aeiou",
  "app_cookie_persistence_profile" : {
    "prst_hdr_name" : "aeiou",
    "encryption_key" : "aeiou",
    "timeout" : 123
  },
  "is_federated" : true,
  "url" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ApplicationPersistenceProfile

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. AppCookiePersistenceProfile
  2. ApplicationPersistenceProfile
  3. ApplicationPersistenceProfileApiResponse
  4. HdrPersistenceProfile
  5. HttpCookiePersistenceKey
  6. HttpCookiePersistenceProfile
  7. IPPersistenceProfile

AppCookiePersistenceProfile Up

encryption_key (optional)
String Key to use for cookie encryption.
prst_hdr_name
String Header or cookie name for application cookie persistence.
timeout (optional)
Integer The length of time after a client's connections have closed before expiring the client's persistence to a server. Allowed values are 1-720. format: int32

ApplicationPersistenceProfile Up

app_cookie_persistence_profile (optional)
AppCookiePersistenceProfile Specifies the Application Cookie Persistence profile parameters.
description (optional)
String User defined description for the object.
hdr_persistence_profile (optional)
HdrPersistenceProfile Specifies the custom HTTP Header Persistence profile parameters.
http_cookie_persistence_profile (optional)
HttpCookiePersistenceProfile Specifies the HTTP Cookie Persistence profile parameters.
ip_persistence_profile (optional)
IPPersistenceProfile Specifies the Client IP Persistence profile parameters.
is_federated (optional)
Boolean This field describes the object's replication scope. If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines. If the field is set to true, then the object is replicated across the federation. . Field introduced in 17.1.3.
name
String A user-friendly name for the persistence profile.
persistence_type
String Method used to persist clients to the same server for a duration of time or a session. Enum options - PERSISTENCE_TYPE_CLIENT_IP_ADDRESS, PERSISTENCE_TYPE_HTTP_COOKIE, PERSISTENCE_TYPE_TLS, PERSISTENCE_TYPE_CLIENT_IPV6_ADDRESS, PERSISTENCE_TYPE_CUSTOM_HTTP_HEADER, PERSISTENCE_TYPE_APP_COOKIE, PERSISTENCE_TYPE_GSLB_SITE.
server_hm_down_recovery (optional)
String Specifies behavior when a persistent server has been marked down by a health monitor. Enum options - HM_DOWN_PICK_NEW_SERVER, HM_DOWN_ABORT_CONNECTION, HM_DOWN_CONTINUE_PERSISTENT_SERVER.
tenant_ref (optional)
String It is a reference to an object of type Tenant.
url (optional)
String url
uuid (optional)
String UUID of the persistence profile.

ApplicationPersistenceProfileApiResponse Up

count
Integer format: int32
results

HdrPersistenceProfile Up

prst_hdr_name (optional)
String Header name for custom header persistence.

HttpCookiePersistenceKey Up

aes_key (optional)
String aes_key of HttpCookiePersistenceKey.
hmac_key (optional)
String hmac_key of HttpCookiePersistenceKey.
name (optional)
String name to use for cookie encryption.

HttpCookiePersistenceProfile Up

always_send_cookie (optional)
Boolean If no persistence cookie was received from the client, always send it.
cookie_name (optional)
String HTTP cookie name for cookie persistence.
encryption_key (optional)
String Key name to use for cookie encryption.
key (optional)
array[HttpCookiePersistenceKey] Placeholder for description of property key of obj type HttpCookiePersistenceProfile field type str type object
timeout (optional)
Integer The length of time after a client's connections have closed before expiring the client's persistence to a server. No value or 'zero' indicates no timeout. Allowed values are 1-14400. Special values are 0- 'No Timeout'. format: int32

IPPersistenceProfile Up

ip_persistent_timeout (optional)
Integer The length of time after a client's connections have closed before expiring the client's persistence to a server. Allowed values are 1-720. format: int32