Management API Reference for ssl-session

A currently established SSL session.

Stability Level: default

Attributes (13)

application-buffer-size - The application buffer size as reported by the SSLSession.

Type	INT
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The application buffer size as reported by the SSLSession.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

cipher-suite - The selected cipher suite as reported by the SSLSession.

Type	STRING
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The selected cipher suite as reported by the SSLSession.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

creation-time - The creation time as reported by the SSLSession.

Type	STRING
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The creation time as reported by the SSLSession.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

last-accessed-time - The last accessed time as reported by the SSLSession.

Type	STRING
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The last accessed time as reported by the SSLSession.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

local-certificates - The local certificates from the SSLSession.

Type	LIST
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "The local certificates from the SSLSession.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "type" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The type of the certificate.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "algorithm" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The algorithm of the public key.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "format" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The format of the public key.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "public-key" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The encoded public key associated with the certificate.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "sha-1-digest" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The SHA-1 digest (finger print) of the certificate.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "sha-256-digest" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The SHA-256 digest (finger print) of the certificate.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "encoded" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The encoded value of the certificate.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "subject" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The subject from the certificate.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "issuer" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The issuer of the certificate.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "not-before" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The starting date and time the certificate is valid.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "not-after" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The expiration date and time of the certificate.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "serial-number" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The serial number of the certificate.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "signature-algorithm" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The algorithm used to generate the certificates signature.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "signature" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The signature of the certificate.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "version" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The certificate version.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

local-principal - The local principal as reported by the SSLSession.

Type	STRING
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The local principal as reported by the SSLSession.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

packet-buffer-size - The packet buffer size as reported by the SSLSession.

Type	INT
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The packet buffer size as reported by the SSLSession.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

peer-certificates - The peer certificates from the SSLSession.

Type	LIST
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "The peer certificates from the SSLSession.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "type" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The type of the certificate.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "algorithm" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The algorithm of the public key.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "format" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The format of the public key.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "public-key" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The encoded public key associated with the certificate.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "sha-1-digest" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The SHA-1 digest (finger print) of the certificate.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "sha-256-digest" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The SHA-256 digest (finger print) of the certificate.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "encoded" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The encoded value of the certificate.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "subject" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The subject from the certificate.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "issuer" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The issuer of the certificate.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "not-before" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The starting date and time the certificate is valid.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "not-after" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The expiration date and time of the certificate.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "serial-number" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The serial number of the certificate.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "signature-algorithm" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The algorithm used to generate the certificates signature.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "signature" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The signature of the certificate.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "version" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The certificate version.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

peer-host - The peer host as reported by the SSLSession.

Type	STRING
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The peer host as reported by the SSLSession.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

peer-port - The peer port as reported by the SSLSession.

Type	INT
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The peer port as reported by the SSLSession.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

peer-principal - The peer principal as reported by the SSLSession.

Type	STRING
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The peer principal as reported by the SSLSession.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

protocol - The protocol as reported by the SSLSession.

Type	STRING
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The protocol as reported by the SSLSession.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

valid - The validity of the session as reported by the SSLSession.

Type	BOOLEAN
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "The validity of the session as reported by the SSLSession.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

Operations (1)

invalidate - Invalidate the SSLSession (Note: This does not terminate current connections, only prevents future connections from joining or resuming this session).

Raw DMR model


{
    "operation-name" : "invalidate",
    "description" : "Invalidate the SSLSession (Note: This does not terminate current connections, only prevents future connections from joining or resuming this session).",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}