F5 Networks · Schema

ClientSslProfile

A Client SSL profile for managing SSL/TLS connections between clients and the BIG-IP system.

API GatewayApplication DeliveryAutomationEdge ComputingKubernetesLoad BalancingMulti-CloudNGINXSecurityWAF

Properties

Name	Type	Description
kind	string
name	string
fullPath	string
generation	integer
selfLink	string
alertTimeout	string	Alert timeout for SSL handshake.
allowNonSsl	string	Whether to allow non-SSL connections.
cert	string	Path to the SSL certificate file.
certKeyChain	array	Certificate and key chain pairs.
ciphers	string	Cipher suite string.
defaultsFrom	string	Parent profile.
description	string
key	string	Path to the SSL private key file.
options	array	SSL options.
peerCertMode	string	Client certificate verification mode.
renegotiation	string	Whether SSL renegotiation is allowed.
secureRenegotiation	string	Secure renegotiation mode.
sniDefault	string	Whether this is the default SNI profile.
sniRequire	string	Whether SNI is required.
sslForwardProxy	string	Whether SSL forward proxy is enabled.
uncleanShutdown	string	How to handle unclean SSL shutdowns.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ClientSslProfile",
  "title": "ClientSslProfile",
  "type": "object",
  "description": "A Client SSL profile for managing SSL/TLS connections between clients and the BIG-IP system.",
  "properties": {
    "kind": {
      "type": "string",
      "example": "tm:ltm:profile:client-ssl:client-sslstate",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "example": "clientssl"
    },
    "fullPath": {
      "type": "string",
      "readOnly": true,
      "example": "example_value"
    },
    "generation": {
      "type": "integer",
      "readOnly": true,
      "example": 10
    },
    "selfLink": {
      "type": "string",
      "format": "uri",
      "readOnly": true,
      "example": "https://www.example.com"
    },
    "alertTimeout": {
      "type": "string",
      "description": "Alert timeout for SSL handshake.",
      "example": "example_value"
    },
    "allowNonSsl": {
      "type": "string",
      "description": "Whether to allow non-SSL connections.",
      "enum": [
        "enabled",
        "disabled"
      ],
      "example": "enabled"
    },
    "cert": {
      "type": "string",
      "description": "Path to the SSL certificate file.",
      "example": "/Common/default.crt"
    },
    "certKeyChain": {
      "type": "array",
      "description": "Certificate and key chain pairs.",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "cert": {
            "type": "string"
          },
          "key": {
            "type": "string"
          },
          "chain": {
            "type": "string"
          }
        }
      },
      "example": []
    },
    "ciphers": {
      "type": "string",
      "description": "Cipher suite string.",
      "example": "DEFAULT"
    },
    "defaultsFrom": {
      "type": "string",
      "description": "Parent profile.",
      "example": "/Common/clientssl"
    },
    "description": {
      "type": "string",
      "example": "A sample description."
    },
    "key": {
      "type": "string",
      "description": "Path to the SSL private key file.",
      "example": "/Common/default.key"
    },
    "options": {
      "type": "array",
      "description": "SSL options.",
      "items": {
        "type": "string"
      },
      "example": []
    },
    "peerCertMode": {
      "type": "string",
      "description": "Client certificate verification mode.",
      "enum": [
        "ignore",
        "require",
        "request"
      ],
      "example": "ignore"
    },
    "renegotiation": {
      "type": "string",
      "description": "Whether SSL renegotiation is allowed.",
      "enum": [
        "enabled",
        "disabled"
      ],
      "example": "enabled"
    },
    "secureRenegotiation": {
      "type": "string",
      "description": "Secure renegotiation mode.",
      "enum": [
        "require",
        "require-strict",
        "request"
      ],
      "example": "require"
    },
    "sniDefault": {
      "type": "string",
      "description": "Whether this is the default SNI profile.",
      "enum": [
        "true",
        "false"
      ],
      "example": "true"
    },
    "sniRequire": {
      "type": "string",
      "description": "Whether SNI is required.",
      "enum": [
        "true",
        "false"
      ],
      "example": "true"
    },
    "sslForwardProxy": {
      "type": "string",
      "description": "Whether SSL forward proxy is enabled.",
      "enum": [
        "enabled",
        "disabled"
      ],
      "example": "enabled"
    },
    "uncleanShutdown": {
      "type": "string",
      "description": "How to handle unclean SSL shutdowns.",
      "enum": [
        "enabled",
        "disabled"
      ],
      "example": "enabled"
    }
  }
}