LTM Profile Server-SSL¶
Overview¶
Use the LTM Profile Server-SSL API to retrieve LTM Profile Server-SSL information from BIG-IQ.
REST Endpoint: /mgmt/cm/adc-core/working-config/ltm/profile/server-ssl¶
Requests¶
Send a GET request to the /ltm/profile/server-ssl endpoint to retrieve all the profiles in the collection. To retrieve a single profile, send the GET request to the /ltm/profile/server-ssl/<id> endpoint. Where the value of placeholder <id> can be found as the UUID appearing in the profile’s selfLink.
GET /mgmt/cm/adc-core/working-config/ltm/profile/server-ssl/<id>¶
Request Parameters¶
None
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
| Name | Type | Description |
|---|---|---|
| alertTimeout | number | Alert timeout in seconds. If alertTimeout is indefinite, alerts can continue without timing out. |
| allowExpiredCrl | string | This certificate revocation list (CRL) file can be used even if it has expired. |
| appService | string | Application service to which this object belongs. |
| authenticate | number | Frequency of authentication |
| authenticateDepth | number | Maximum traversal depth of the client certificate chain |
| authenticateName | string | Specifies a Common Name (CN) that is embedded in a server certificate. The system authenticates a server based on the specified CN. |
| bypassOnClientCertFail | string | The value of bypassOnClientCertFail indicates whether bypass SSL forward proxy traffic will be enabled or disabled in the following case: the server requests the Client Certificate from the BIG-IP and fails to receive the certificate. The default is “disabled”. |
| bypassOnHandshakeAlert | string | The value of bypassOnHandshakeAlert indicates whether bypass SSL forward proxy traffic has been enabled or disabled for the following case: the server requests the Client Certificate from the BIG-IP and receives a handshake_failure(40) alert. The default is “disabled”. |
| cacheSize | number | SSL session cache size. For client-side profiles only, you can configure the timeout and size of the SSL session cache. You can configure the values on a per-profile basis because each profile maintains a separate SSL session cache. |
| cacheTimeout | number | SSL session cache timeout in seconds. This is the usable lifetime of negotiated SSL session IDs. The possible values are integers greater than or equal to 0 and less than or equal to 86400. The default is 3600 seconds. |
| caFile | string | Certificate authority (CA) file name. Configures certificate verification by specifying a list of client or server CAs that the traffic management system trusts. |
| cert | string | Name of the certificate installed on the traffic management system for the purpose of initiating or terminating a SSL connection. The default is “none”. |
| chain | string | Certificate chain file that a client can use to authenticate the profile. |
| cipherGroup | string | Associated cipher group |
| ciphers | string | A cipher name |
| crlFile | string | Certificate revocation list (CRL) file name, or indicates the system uses the CRL file name from the parent profile. |
| defaultsFrom | string | The parent profile. A new profile inherits all settings and values from this parent profile. |
| description | string | User described description |
| expireCertResponseControl | string | Action taken by the BIG-IP if the server certificate has expired. The default is to “drop”, which causes the connection to be dropped. Alternatively, “ignore” causes the connection to ignore the error and continue. Note that “drop” works only if the certificate is trusted. |
| genericAlert | string | Generic-alert has been “enabled” or “disabled”. This can use generic alert number in alert message. The default is “enabled”. |
| handshakeTimeout | number | Handshake timeout in seconds. handshakeTimeout can be indefinite which continues without a timeout. |
| isenabled | string | Enables or disables SSL processing. |
| key | string | Name of the key installed on the traffic management system for the purpose of initiating or terminating a SSL connection. The default is none. |
| maxActiveHandshakes | number | Maximum number of active handshakes allowed. The default is 0. |
| modSslMethods | string | ModSSL method emulation has been “enabled” or “disabled”. Use “enabled” if OpenSSL methods are inadequate. For example, enable ModSSL method emulation to use SSL compression over TLSv1. |
| partition | string | Administrative partition containing this profile. The default is “Common”. |
| passphrase | string | Key passphrase |
| peerCertMode | string | Peer certificate mode. The default is to ignore. |
| proxySsl | string | Proxy SSL mode has been “enabled” or “disabled”. The proxy SSL mode requires a corresponding client SSL profile with proxy-ssl enabled to allow for modification of application data within an SSL tunnel. proxySsl is “disabled” by default. |
| proxySslPassthrough | string | Proxy SSL passthrough mode has been “enabled” or “disabled”. The proxy SSL passthrough mode requires a corresponding client SSL profile with proxy-ssl-passthrough enabled to allow for modification of application data within an SSL tunnel. proxySslPassthrough is “disabled” by default. |
| renegotiatePeriod | number | Number of seconds from the initial connect time after which the system renegotiates an SSL session. A new connection is started each time a session renegotiation is successful. The system then attempts to renegotiate the session again after the specified amount of time following the previous renegotiation. For example, a renegotiatePeriod of 3600 seconds triggers session renegotiation at least once an hour. The default is indefinite meaning do not renegotiate SSL sessions. |
| renegotiateSize | number | Throughput size in bytes of SSL renegotiation. This forces the traffic management system to renegotiate an SSL session based on the size, in megabytes, of application data that is transmitted over the secure channel. The default is indefinite which means do not renegotiate based on throughput size. |
| renegotiation | string | Mid-stream renegotiation has been “enabled” or “disabled”. The default is “enabled”. |
| retainCertificate | boolean | If true, the server certificate is retained in SSL session. The default is true. |
| secureRenegotiation | string | Secure renegotiation has been “enabled” or “disabled”. The default is require-strict. |
| selfLink | string | The selfLink of an application. |
| serverName | string | Name matched to TLS/1.1 and above client SSL requests that support the Server Name Indication extension. The default value is empty, which disables support for this extension. |
| sessionMirroring | string | Session mirroring to the high-availability peer has been “enabled” or “disabled”. The default is “disabled”. |
| sessionTicket | string | Session-ticket has been “enabled” or “disabled”. The default option is disabled, see RFC5077. |
| sniDefault | boolean | If true, this profile is the default SSL profile when a client connection does not specify a known server name, or does not specify any server name. The default is false. |
| sniRequire | boolean | If true, SNI support is required for the peer. If a client connection does not specify a known server name, or does not specify any server name, the connection will be rejected. The default is false. |
| sslForwardProxy | string | SSL Forward Proxy feature has been “enabled” or “disabled”. The default is “disabled”. |
| sslForwardProxyBypass | string | SSL Forward Proxy Bypass feature has been “enabled” or “disabled”. The default is “disabled”. |
| sslSignHash | string | SSL sign hash algorithm used to sign and verify SSL Server Key Exchange and Certificate Verify messages for the SSL profile. The default is “any”. |
| strictResume | string | Indicates that the resumption of SSL sessions after an unclean shutdown has been “enabled” or “disabled”. The default is “disabled”, which means that the SSL profile can refuse to resume SSL sessions after an unclean shutdown. |
| tmOptions | string | Enabled options, including some industry-related workarounds. Options list is entered between braces, for example, “{dont-insert-empty-fragments microsoft-sess-id-bug}”. The default is “{dont-insert-empty-fragments}”, which disables a countermeasure against a SSL 3.0/TLS 1.0 protocol vulnerability affecting CBC ciphers. |
| uncleanShutdown | string | By default, the SSL profile performs unclean shutdowns of all SSL connections. This means that underlying TCP connections are closed without exchanging the required SSL shutdown alerts. If uncleanShutdown is “disable”, the SSL profile performs a clean shutdown of all SSL connections. |
| untrustedCertResponseControl | string | System action when the server certificate has an untrusted CA. The default is “drop”, which causes the connection to be dropped. If “ignore”, the connection ignores the error and continues. |
Permissions¶
| Role | Allow |
|---|---|
| Trust_Discovery_Import | Yes |
| ADC_Deployer | Yes |
| Service_Catalog_Viewer | Yes |
| Application_Editor | Yes |
| Application_Manager | Yes |
| Application_Viewer | Yes |
| Service_Catalog_Editor | Yes |
| ADC_Manager | Yes |
| ADC_Editor | Yes |
| ADC_Viewer | Yes |
| Access_View | Yes |
| Access_Edit | Yes |
| Access_Manager | Yes |
| Access_Deploy | Yes |
| Access_Policy_Editor | Yes |
POST /mgmt/cm/adc-core/working-config/ltm/profile/server-ssl¶
Send a POST request to the /ltm/profile/server-ssl endpoint to add a profile to the collection.
Request Parameters¶
| Name | Type | Required | Description |
|---|---|---|---|
| alertTimeout | number | False | Alert timeout in seconds. Specify “indefinite” to enable alerts to continue without timing out. |
| allowExpiredCrl | string | False | Use the specified certificate revocation file (CRL) file even if it has expired. |
| appService | string | False | Application service to which the object belongs |
| authenticate | number | False | Frequency of authentication |
| authenticateDepth | number | False | Maximum traversal depth of the client certificate chain. |
| authenticateName | string | False | Specifies a Common Name (CN) that is embedded in a server certificate. The system authenticates a server based on the specified CN. |
| bypassOnClientCertFail | string | False | Specifies that if a server requests the Client Certificate from the BIG-IP, and fails to receive the certificate, the bypass SSL forward proxy traffic is “enabled” or “disabled”. The default is “disabled”. |
| bypassOnHandshakeAlert | string | False | Specifies that if a server requests the Client Certificate from the BIG-IP, and receives a handshake_failure(40) alert, the bypass SSL forward proxy traffic is “enabled” or “disabled”. The default is “disabled”. |
| cacheSize | number | False | SSL session cache size. For client-side profiles only, you can configure timeout and size values for the SSL session cache. You can configure the values on a per-profile basis because each profile maintains a separate SSL session cache. |
| cacheTimeout | number | False | SSL session cache timeout in seconds. This is the usable lifetime of negotiated SSL session IDs. The default is 3600 seconds. Possible values are integers greater than or equal to 0 and less than or equal to 86400. |
| caFile | string | False | The certificate authority (CA) file name. Configures certificate verification by specifying a list of client or server CAs that the traffic management system trusts. |
| cert | string | False | Name of the certificate installed on the traffic management system for the purpose of initiating or terminating a SSL connection. The default is none. |
| chain | string | False | Certificate chain file that a client can use to authenticate the profile. |
| cipherGroup | string | False | Specifies an associated cipher group. |
| ciphers | string | False | A cipher name |
| crlFile | string | False | Specifies the certificate revocation list (CRL) file name or indicates the system uses the certificate revocation file name from the parent profile. |
| defaultsFrom | string | False | Profile to use as the parent profile. New profiles can inherit all settings from the parent profile. |
| description | string | False | User described description |
| expireCertResponseControl | string | False | Action taken by the BIG-IP if the server certificate has expired. The default is drop, which causes the connection to be dropped. Specify “ignore” to cause the connection to ignore the error and continue. Note that drop works only if the certificate is trusted. |
| genericAlert | string | False | Enables or disables generic-alert. Possible values are “enabled” and “disabled”. These can use the generic alert number in alert message. The default is “enabled”. |
| handshakeTimeout | number | False | Handshake timeout in seconds. Specify “indefinite” to continue without timing out. |
| isenabled | string | False | Enables or disables SSL processing. Possible values are “enabled” and “disabled”. |
| key | string | False | Name of the key installed on the traffic management system for the purpose of initiating or terminating a SSL connection. The default is “none”. |
| maxActiveHandshakes | number | False | Maximum number of active handshakes allowed. The default is 0. |
| modSslMethods | string | False | Enables or disables ModSSL method emulation. Possible values are “enabled” and “disabled”. Use “enabled” if OpenSSL methods are inadequate. For example, you can enable ModSSL method emulation to use SSL compression over TLSv1. |
| partition | string | False | Administrative partition where this profile is located. The default is “Common”. |
| passphrase | string | False | Key passphrase |
| peerCertMode | string | False | Peer certificate mode. The default is to ignore. |
| proxySsl | string | False | Enables or disables proxy SSL mode. Possible values are “enabled” and “disabled”. Enabling this mode requires a corresponding client SSL profile with proxy-ssl enabled to allow for modification of application data within an SSL tunnel. The default is “disabled”. |
| proxySslPassthrough | string | False | Enables or disables proxy SSL passthrough mode. Enabling this mode requires a corresponding client SSL profile with proxy-ssl-passthrough enabled to allow for modification of application data within an SSL tunnel. The default is “disabled”. |
| renegotiatePeriod | number | False | Number of seconds from initial connect time after which the system renegotiates an SSL session. A new connection is started each time a session renegotiation is successful. The system then attempts to renegotiate the session again after the specified amount of time following the previous renegotiation. For example, a renegotiatePeriod of 3600 seconds triggers session renegotiation at least once an hour. The default is indefinite meaning do not renegotiate SSL sessions. |
| renegotiateSize | number | False | Throughput size in bytes of SSL renegotiation. This forces the traffic management system to renegotiate an SSL session based on the size, in megabytes, of application data that is transmitted over the secure channel. The default is indefinite which means do not renegotiate based on throughput size. |
| renegotiation | string | False | Enables or disables mid-stream renegotiation. Possible values are “enabled” and “disabled”. The default is “enabled”. |
| retainCertificate | boolean | False | If true, server certificate is retained in SSL session. The default is true. |
| secureRenegotiation | string | False | Enables or disables secure renegotiation. Possible values are “enabled” and “disabled”. The default is require-strict. |
| selfLink | string | False | The selfLink of an application. |
| serverName | string | False | Name matched to TLS/1.1 and above client SSL requests that support the Server Name Indication extension. The default is empty, which disables support for this extension. |
| sessionMirroring | string | False | Enables or disables session mirroring to the high-availability peer. Possible values are “enabled” and “disabled”. The default option is “disabled”. |
| sessionTicket | string | False | Enables or disables session-ticket. Possible values are “enabled” and “disabled”. The default is “disabled”, see RFC5077. |
| sniDefault | boolean | False | If true, this profile is the default SSL profile when a client connection does not specify a known server name, or does not specify any server name. The default is false. |
| sniRequire | boolean | False | If true, SNI support is required for the peer. If a client connection does not specify a known server name, or does not specify any server name, the connection will be rejected. The default is false. |
| sslForwardProxy | string | False | Enables or disables SSL Forward Proxy. Possible values are “enabled” and “disabled”. The default is “disabled”. |
| sslForwardProxyBypass | string | False | Enables or disables SSL Forward Proxy Bypass. Possible values are “enabled” and “disabled”. The default value is disabled. |
| sslSignHash | string | False | SSL sign hash algorithm to sign and verify SSL Server Key Exchange and Certificate Verify messages for the specified SSL profiles. The default is “any”. |
| strictResume | string | False | Enables or disables the resumption of SSL sessions after an unclean shutdown. Possible values are “enabled” and “disabled”. The default is “disabled”, which indicates that the SSL profile refuses to resume SSL sessions after an unclean shutdown. |
| tmOptions | string | False | Enables options, including some industry-related workarounds. Enter options inside braces, for example, “{ dont-insert-empty-fragments microsoft-sess-id-bug}”. The default value is “dont-insert-empty-fragments”, which disables a countermeasure against a SSL 3.0/TLS 1.0 protocol vulnerability affecting CBC ciphers. |
| uncleanShutdown | string | False | By default, the SSL profile performs unclean shutdowns of all SSL connections, which means that underlying TCP connections are closed without exchanging the required SSL shutdown alerts. If uncleanShutdown is “disable”, the SSL profile to performs a clean shutdown of all SSL connections. |
| untrustedCertResponseControl | string | False | Specifies the system action when the server certificate has an untrusted CA. The default value is drop, which causes the connection to be dropped. Conversely, you can specify ignore to cause the connection to ignore the error and continue. The default is drop. |
Query Parameters¶
None
Permissions¶
| Role | Allow |
|---|---|
| Trust_Discovery_Import | Yes |
| ADC_Deployer | Yes |
| Service_Catalog_Viewer | Yes |
| Application_Editor | Yes |
| Application_Manager | Yes |
| Application_Viewer | Yes |
| Service_Catalog_Editor | Yes |
| ADC_Manager | Yes |
| ADC_Editor | Yes |
| ADC_Viewer | Yes |
| Access_View | Yes |
| Access_Edit | Yes |
| Access_Manager | Yes |
| Access_Deploy | Yes |
| Access_Policy_Editor | Yes |
PATCH /mgmt/cm/adc-core/working-config/ltm/profile/server-ssl/<id>¶
Send a PATCH request, and specify the profile’s <id>, to replace the specified profile in the collection.
To change selected parameters of an existing server-ssl profile, send a PATCH request to the /ltm/profile/server-ssl/<id> endpoint. Where the value of placeholder <id> can be found as the UUID appearing in the profile’s selfLink.
Request Parameters¶
The JSON in the body of the PATCH request can contain the same parameters as a POST request. Only the parameters that are being updated need to be included in the body of the request.
Query Parameters¶
None
Permissions¶
| Role | Allow |
|---|---|
| Trust_Discovery_Import | Yes |
| ADC_Deployer | Yes |
| Service_Catalog_Viewer | Yes |
| Application_Editor | Yes |
| Application_Manager | Yes |
| Application_Viewer | Yes |
| Service_Catalog_Editor | Yes |
| ADC_Manager | Yes |
| ADC_Editor | Yes |
| ADC_Viewer | Yes |
| Access_View | Yes |
| Access_Edit | Yes |
| Access_Manager | Yes |
| Access_Deploy | Yes |
| Access_Policy_Editor | Yes |
PUT /mgmt/cm/adc-core/working-config/ltm/profile/server-ssl/<id>¶
To replace an existing server-ssl profile from the collection, send a PUT request to the /ltm/profile/server-ssl/<id> endpoint. Where the value of placeholder <id> can be found as the UUID appearing in the profile’s selfLink.
Request Parameters¶
The JSON in the body of the PUT request can contain the same parameters as a POST request.
Query Parameters¶
None
Permissions¶
| Role | Allow |
|---|---|
| Trust_Discovery_Import | Yes |
| ADC_Deployer | Yes |
| Service_Catalog_Viewer | Yes |
| Application_Editor | Yes |
| Application_Manager | Yes |
| Application_Viewer | Yes |
| Service_Catalog_Editor | Yes |
| ADC_Manager | Yes |
| ADC_Editor | Yes |
| ADC_Viewer | Yes |
| Access_View | Yes |
| Access_Edit | Yes |
| Access_Manager | Yes |
| Access_Deploy | Yes |
| Access_Policy_Editor | Yes |
DELETE /mgmt/cm/adc-core/working-config/ltm/profile/server-ssl/<id>¶
To delete an existing server-ssl profile from the collection, send a DELETE request to the /ltm/profile/server-ssl/<id> endpoint. Where the value of placeholder <id> can be found as the UUID appearing in the profile’s selfLink.
Request Parameters¶
None
Query Parameters¶
None
Permissions¶
| Role | Allow |
|---|---|
| Trust_Discovery_Import | Yes |
| ADC_Deployer | Yes |
| Service_Catalog_Viewer | Yes |
| Application_Editor | Yes |
| Application_Manager | Yes |
| Application_Viewer | Yes |
| Service_Catalog_Editor | Yes |
| ADC_Manager | Yes |
| ADC_Editor | Yes |
| ADC_Viewer | Yes |
| Access_View | Yes |
| Access_Edit | Yes |
| Access_Manager | Yes |
| Access_Deploy | Yes |
| Access_Policy_Editor | Yes |
Examples¶
None