NSX-T Data Center REST API

Update a load balancer client-ssl profile (Deprecated)

Update a load balancer client-ssl profile.
Deprecated:
NSX-T Load Balancer is deprecated.
Please take advantage of NSX Advanced Load Balancer.
Refer to Policy > Networking > Network Services > Advanced Load Balancing section of the API guide.

Request:

Method:

PUT

URI Path(s):

/api/v1/loadbalancer/client-ssl-profiles/{client-ssl-profile-id}

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

LbClientSslProfile+

LbClientSslProfile (schema)

(Deprecated)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
cipher_group_label	Label of cipher group It is a label of cipher group which is mostly consumed by GUI.	SslCipherGroup
ciphers	supported SSL cipher list to client side	array of SslCipher
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
is_fips	FIPS compliance of ciphers and protocols This flag is set to true when all the ciphers and protocols are FIPS compliant. It is set to false when one of the ciphers or protocols are not FIPS compliant.	boolean	Readonly
is_secure	Secure/Insecure SSL profile flag This flag is set to true when all the ciphers and protocols are secure. It is set to false when one of the ciphers or protocols is insecure.	boolean	Readonly
prefer_server_ciphers	prefer server ciphers flag During SSL handshake as part of the SSL client Hello client sends an ordered list of ciphers that it can support (or prefers) and typically server selects the first one from the top of that list it can also support. For Perfect Forward Secrecy(PFS), server could override the client's preference.	boolean	Default: "True"
protocols	supported SSL protocol list to client side Only TLS 1.2 is supported and enabled.	array of SslProtocol
resource_type	Must be set to the value LbClientSslProfile	string
session_cache_enabled	session cache enable/disable flag SSL session caching allows SSL client and server to reuse previously negotiated security parameters avoiding the expensive public key operation during handshake.	boolean	Default: "True"
session_cache_timeout	SSL session cache timeout value Session cache timeout specifies how long the SSL session parameters are held on to and can be reused.	integer	Minimum: 1 Maximum: 86400 Default: "300"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

{ "resource_type" : "LbClientSslProfile", "id" : "0bf84c53-6b60-48e6-8837-5a106841cfb6", "display_name" : "client-ssl-profile1", "prefer_server_ciphers" : false, "ciphers" : [ "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384" ], "is_secure" : true, "protocols" : [ "TLS_V1_2" ], "session_cache_enabled" : true, "session_cache_timeout" : 300, "_create_time" : 1515743444200, "_last_modified_user" : "admin", "_last_modified_time" : 1515743444200, "_system_owned" : false, "_create_user" : "admin", "_protection" : "NOT_PROTECTED", "_revision" : 0 }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

LbClientSslProfile+

LbClientSslProfile (schema)

(Deprecated)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
cipher_group_label	Label of cipher group It is a label of cipher group which is mostly consumed by GUI.	SslCipherGroup
ciphers	supported SSL cipher list to client side	array of SslCipher
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
is_fips	FIPS compliance of ciphers and protocols This flag is set to true when all the ciphers and protocols are FIPS compliant. It is set to false when one of the ciphers or protocols are not FIPS compliant.	boolean	Readonly
is_secure	Secure/Insecure SSL profile flag This flag is set to true when all the ciphers and protocols are secure. It is set to false when one of the ciphers or protocols is insecure.	boolean	Readonly
prefer_server_ciphers	prefer server ciphers flag During SSL handshake as part of the SSL client Hello client sends an ordered list of ciphers that it can support (or prefers) and typically server selects the first one from the top of that list it can also support. For Perfect Forward Secrecy(PFS), server could override the client's preference.	boolean	Default: "True"
protocols	supported SSL protocol list to client side Only TLS 1.2 is supported and enabled.	array of SslProtocol
resource_type	Must be set to the value LbClientSslProfile	string
session_cache_enabled	session cache enable/disable flag SSL session caching allows SSL client and server to reuse previously negotiated security parameters avoiding the expensive public key operation during handshake.	boolean	Default: "True"
session_cache_timeout	SSL session cache timeout value Session cache timeout specifies how long the SSL session parameters are held on to and can be reused.	integer	Minimum: 1 Maximum: 86400 Default: "300"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "resource_type" : "LbClientSslProfile", "id" : "0bf84c53-6b60-48e6-8837-5a106841cfb6", "display_name" : "client-ssl-profile1", "prefer_server_ciphers" : false, "ciphers" : [ "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384" ], "is_secure" : true, "protocols" : [ "TLS_V1_2" ], "session_cache_enabled" : true, "session_cache_timeout" : 300, "_create_time" : 1515743444200, "_last_modified_user" : "admin", "_last_modified_time" : 1515744251536, "_system_owned" : false, "_create_user" : "admin", "_protection" : "NOT_PROTECTED", "_revision" : 1 }

Required Permissions:

crud

Feature:

lb_ssl_profiles

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable