Avi SSLProfile Object API

CLI ``` - configure sslprofile - show sslprofile ``` Examples - **sslprofile_example**: To create a standard security SSL profile ```json {'name': 'Standard', 'accepted_versions': [{'type': 'SSL_VERSION_TLS1'}, {'type': 'SSL_VERSION_TLS1'}, {'type': 'SSL_VERSION_TLS1_1'}, {'type': 'SSL_VERSION_TLS1_2'}], 'accepted_ciphers': 'aECDSA:aECDH:kEDH:kRSA'} ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 22.1.5
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 /sslprofile
  2. post /sslprofile
  3. delete /sslprofile/{uuid}
  4. get /sslprofile/{uuid}/federated_info/
  5. get /sslprofile/{uuid}
  6. patch /sslprofile/{uuid}
  7. put /sslprofile/{uuid}
Up 
get /sslprofile
(sslprofileGet)

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.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

SSLProfileApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "enable_ssl_session_reuse" : true,
    "accepted_versions" : [ {
      "type" : "aeiou"
    } ],
    "ssl_session_timeout" : 123,
    "ec_named_curve" : "aeiou",
    "enable_early_data" : true,
    "description" : "aeiou",
    "type" : "aeiou",
    "ciphersuites" : "aeiou",
    "uuid" : "aeiou",
    "url" : "aeiou",
    "_last_modified" : "aeiou",
    "tags" : [ {
      "type" : "aeiou",
      "value" : "aeiou"
    } ],
    "send_close_notify" : true,
    "ssl_rating" : {
      "performance_rating" : "aeiou",
      "security_score" : "aeiou",
      "compatibility_rating" : "aeiou"
    },
    "accepted_ciphers" : "aeiou",
    "cipher_enums" : [ "aeiou" ],
    "dhparam" : "aeiou",
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "prefer_client_cipher_ordering" : true,
    "configpb_attributes" : {
      "version" : 123
    },
    "signature_algorithm" : "aeiou",
    "markers" : [ {
      "values" : [ "aeiou" ],
      "key" : "aeiou"
    } ],
    "is_federated" : true
  } ]
}

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 SSLProfileApiResponse

401

log in failed
Up 
post /sslprofile
(sslprofilePost)

Consumes

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

Request body

body (required)
Body Parameter — SSLProfile object creation

Return type

SSLProfile

Example data

Content-Type: application/json
{
  "enable_ssl_session_reuse" : true,
  "accepted_versions" : [ {
    "type" : "aeiou"
  } ],
  "ssl_session_timeout" : 123,
  "ec_named_curve" : "aeiou",
  "enable_early_data" : true,
  "description" : "aeiou",
  "type" : "aeiou",
  "ciphersuites" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "tags" : [ {
    "type" : "aeiou",
    "value" : "aeiou"
  } ],
  "send_close_notify" : true,
  "ssl_rating" : {
    "performance_rating" : "aeiou",
    "security_score" : "aeiou",
    "compatibility_rating" : "aeiou"
  },
  "accepted_ciphers" : "aeiou",
  "cipher_enums" : [ "aeiou" ],
  "dhparam" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "prefer_client_cipher_ordering" : true,
  "configpb_attributes" : {
    "version" : 123
  },
  "signature_algorithm" : "aeiou",
  "markers" : [ {
    "values" : [ "aeiou" ],
    "key" : "aeiou"
  } ],
  "is_federated" : true
}

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 SSLProfile

401

log in failed
Up 
delete /sslprofile/{uuid}
(sslprofileUuidDelete)

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 /sslprofile/{uuid}/federated_info/
(sslprofileUuidFederatedInfoGet)

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 /sslprofile/{uuid}
(sslprofileUuidGet)

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.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

SSLProfile

Example data

Content-Type: application/json
{
  "enable_ssl_session_reuse" : true,
  "accepted_versions" : [ {
    "type" : "aeiou"
  } ],
  "ssl_session_timeout" : 123,
  "ec_named_curve" : "aeiou",
  "enable_early_data" : true,
  "description" : "aeiou",
  "type" : "aeiou",
  "ciphersuites" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "tags" : [ {
    "type" : "aeiou",
    "value" : "aeiou"
  } ],
  "send_close_notify" : true,
  "ssl_rating" : {
    "performance_rating" : "aeiou",
    "security_score" : "aeiou",
    "compatibility_rating" : "aeiou"
  },
  "accepted_ciphers" : "aeiou",
  "cipher_enums" : [ "aeiou" ],
  "dhparam" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "prefer_client_cipher_ordering" : true,
  "configpb_attributes" : {
    "version" : 123
  },
  "signature_algorithm" : "aeiou",
  "markers" : [ {
    "values" : [ "aeiou" ],
    "key" : "aeiou"
  } ],
  "is_federated" : true
}

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 SSLProfile

401

log in failed
Up 
patch /sslprofile/{uuid}
(sslprofileUuidPatch)

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 — SSLProfile object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

SSLProfile

Example data

Content-Type: application/json
{
  "enable_ssl_session_reuse" : true,
  "accepted_versions" : [ {
    "type" : "aeiou"
  } ],
  "ssl_session_timeout" : 123,
  "ec_named_curve" : "aeiou",
  "enable_early_data" : true,
  "description" : "aeiou",
  "type" : "aeiou",
  "ciphersuites" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "tags" : [ {
    "type" : "aeiou",
    "value" : "aeiou"
  } ],
  "send_close_notify" : true,
  "ssl_rating" : {
    "performance_rating" : "aeiou",
    "security_score" : "aeiou",
    "compatibility_rating" : "aeiou"
  },
  "accepted_ciphers" : "aeiou",
  "cipher_enums" : [ "aeiou" ],
  "dhparam" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "prefer_client_cipher_ordering" : true,
  "configpb_attributes" : {
    "version" : 123
  },
  "signature_algorithm" : "aeiou",
  "markers" : [ {
    "values" : [ "aeiou" ],
    "key" : "aeiou"
  } ],
  "is_federated" : true
}

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 SSLProfile

401

log in failed
Up 
put /sslprofile/{uuid}
(sslprofileUuidPut)

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 — SSLProfile object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

SSLProfile

Example data

Content-Type: application/json
{
  "enable_ssl_session_reuse" : true,
  "accepted_versions" : [ {
    "type" : "aeiou"
  } ],
  "ssl_session_timeout" : 123,
  "ec_named_curve" : "aeiou",
  "enable_early_data" : true,
  "description" : "aeiou",
  "type" : "aeiou",
  "ciphersuites" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "tags" : [ {
    "type" : "aeiou",
    "value" : "aeiou"
  } ],
  "send_close_notify" : true,
  "ssl_rating" : {
    "performance_rating" : "aeiou",
    "security_score" : "aeiou",
    "compatibility_rating" : "aeiou"
  },
  "accepted_ciphers" : "aeiou",
  "cipher_enums" : [ "aeiou" ],
  "dhparam" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "prefer_client_cipher_ordering" : true,
  "configpb_attributes" : {
    "version" : 123
  },
  "signature_algorithm" : "aeiou",
  "markers" : [ {
    "values" : [ "aeiou" ],
    "key" : "aeiou"
  } ],
  "is_federated" : true
}

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 SSLProfile

401

log in failed
Up

Models

[ Jump to Methods ]

Table of Contents

  1. ConfigPbAttributes
  2. KeyValue
  3. RoleFilterMatchLabel
  4. SSLProfile
  5. SSLProfileApiResponse
  6. SSLRating
  7. SSLVersion
  8. Tag

ConfigPbAttributes Up

version (optional)
Integer Protobuf version number. Gets incremented if there is se Diff of federated diff in config pbs.This field will be a monotonically increasing number indicating the number of Config Update operations. 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. format: int32

KeyValue Up

key
String Key. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value (optional)
String Value. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

RoleFilterMatchLabel Up

key
String Key for filter match. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
values (optional)
array[String] Values for filter match. Multiple values will be evaluated as OR. Example key = value1 OR key = value2. Behavior for match is key = * if this field is empty. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

SSLProfile Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
accepted_ciphers (optional)
String Ciphers suites represented as defined by https //www.openssl.org/docs/man1.1.1/man1/ciphers.html. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
accepted_versions (optional)
array[SSLVersion] Set of versions accepted by the server. Minimum of 1 items required. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
cipher_enums (optional)
array[String] Enum options - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_GCM_SHA384, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_3DES_EDE_CBC_SHA, TLS_AES_256_GCM_SHA384, TLS_CHACHA20_POLY1305_SHA256, TLS_AES_128_GCM_SHA256. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_RSA_WITH_AES_128_GCM_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384,TLS_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_CBC_SHA256,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_256_CBC_SHA,TLS_RSA_WITH_3DES_EDE_CBC_SHA), Basic edition(Allowed values- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_RSA_WITH_AES_128_GCM_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384,TLS_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_CBC_SHA256,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_256_CBC_SHA,TLS_RSA_WITH_3DES_EDE_CBC_SHA), Enterprise with Cloud Services edition.
ciphersuites (optional)
String TLS 1.3 Ciphers suites represented as defined by U(https //www.openssl.org/docs/man1.1.1/man1/ciphers.html). Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Special default for Essentials edition is TLS_AES_256_GCM_SHA384-TLS_AES_128_GCM_SHA256, Basic edition is TLS_AES_256_GCM_SHA384-TLS_AES_128_GCM_SHA256, Enterprise is TLS_AES_256_GCM_SHA384-TLS_CHACHA20_POLY1305_SHA256-TLS_AES_128_GCM_SHA256.
configpb_attributes (optional)
ConfigPbAttributes 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 (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dhparam (optional)
String DH Parameters used in SSL. At this time, it is not configurable and is set to 2048 bits. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ec_named_curve (optional)
String Elliptic Curve Cryptography NamedCurves (TLS Supported Groups)represented as defined by RFC 8422-Section 5.1.1 andhttps //www.openssl.org/docs/man1.1.0/man3/SSL_CTX_set1_curves.html. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
enable_early_data (optional)
Boolean Enable early data processing for TLS1.3 connections. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.
enable_ssl_session_reuse (optional)
Boolean Enable SSL session re-use. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
is_federated (optional)
Boolean It Specifies whether the object has to be replicated to the GSLB followers. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
markers (optional)
array[RoleFilterMatchLabel] 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
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
prefer_client_cipher_ordering (optional)
Boolean Prefer the SSL cipher ordering presented by the client during the SSL handshake over the one specified in the SSL Profile. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
send_close_notify (optional)
Boolean Send 'close notify' alert message for a clean shutdown of the SSL connection. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
signature_algorithm (optional)
String Signature Algorithms represented as defined by RFC5246-Section 7.4.1.4.1 andhttps //www.openssl.org/docs/man1.1.0/man3/SSL_CTX_set1_client_sigalgs_list.html. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ssl_rating (optional)
SSLRating Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ssl_session_timeout (optional)
Integer The amount of time in seconds before an SSL session expires. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
tags (optional)
array[Tag] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_ref (optional)
String 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 (optional)
String SSL Profile Type. Enum options - SSL_PROFILE_TYPE_APPLICATION, SSL_PROFILE_TYPE_SYSTEM. Field introduced in 17.2.8. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
String url
uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

SSLProfileApiResponse Up

count
Integer format: int32
results
array[SSLProfile]
next (optional)
String

SSLRating Up

compatibility_rating (optional)
String Enum options - SSL_SCORE_NOT_SECURE, SSL_SCORE_VERY_BAD, SSL_SCORE_BAD, SSL_SCORE_AVERAGE, SSL_SCORE_GOOD, SSL_SCORE_EXCELLENT. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
performance_rating (optional)
String Enum options - SSL_SCORE_NOT_SECURE, SSL_SCORE_VERY_BAD, SSL_SCORE_BAD, SSL_SCORE_AVERAGE, SSL_SCORE_GOOD, SSL_SCORE_EXCELLENT. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
security_score (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

SSLVersion Up

type
String Enum options - SSL_VERSION_SSLV3, SSL_VERSION_TLS1, SSL_VERSION_TLS1_1, SSL_VERSION_TLS1_2, SSL_VERSION_TLS1_3. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- SSL_VERSION_SSLV3,SSL_VERSION_TLS1,SSL_VERSION_TLS1_1,SSL_VERSION_TLS1_2), Basic edition(Allowed values- SSL_VERSION_SSLV3,SSL_VERSION_TLS1,SSL_VERSION_TLS1_1,SSL_VERSION_TLS1_2), Enterprise with Cloud Services edition.

Tag Up

type (optional)
String Enum options - AVI_DEFINED, USER_DEFINED, VCENTER_DEFINED. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.