aam authentication server ocsp instance

Configure an authentication-server instance for an Online Certificate Status Protocol (OCSP).

instance Specification

Type Collection
Object Key(s) name
Collection Name instance-list
Collection URI /axapi/v3/aam/authentication/server/ocsp/instance/
Element Name instance
Element URI /axapi/v3/aam/authentication/server/ocsp/instance/{name}
Element Attributes instance_attributes
Statistics Data URI /axapi/v3/aam/authentication/server/ocsp/instance/{name}/stats
Schema instance schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/aam/authentication/server/ocsp/instance/

instance Attributes

Create List

POST

/axapi/v3/aam/authentication/server/ocsp/instance/

instance Attributes

Get Object

GET

/axapi/v3/aam/authentication/server/ocsp/instance/{name}

instance Attributes

Get List

GET

/axapi/v3/aam/authentication/server/ocsp/instance/

instance-list

Modify Object

POST

/axapi/v3/aam/authentication/server/ocsp/instance/{name}

instance Attributes

Replace Object

PUT

/axapi/v3/aam/authentication/server/ocsp/instance/{name}

instance Attributes

Replace List

PUT

/axapi/v3/aam/authentication/server/ocsp/instance/

instance-list

Delete Object

DELETE

/axapi/v3/aam/authentication/server/ocsp/instance/{name}

instance Attributes

Get Stats

GET

/axapi/v3/aam/authentication/server/ocsp/instance/{name}/stats

stats data

instance-list

instance-list is JSON List of instance Attributes

instance-list : [

instance Attributes

health-check

Description: Enable checking of the port’s health check status. health-check and health-check-disable are mutually exclusive, so you will only configure one or the other.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: health-check and health-check-disable are mutually exclusive

health-check-disable

Description: Disable the configured port health check configuration. health-check and health-check-disable are mutually exclusive, so you will only configure one or the other.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: health-check-disable and health-check are mutually exclusive

health-check-string

Description: Specify the name of an existing health check monitor. For use with health-check .

Type: string

Reference Object: /axapi/v3/health/monitor

name

Description: Specify the OCSP authentication server name.

Type: string

Format: string-rlx

Required: Yes

port-health-check

Description: Check port’s health status

Type: string

Mutual Exclusion: port-health-check and port-health-check-disable are mutually exclusive

Reference Object: /axapi/v3/health/monitor

port-health-check-disable

Description: Disable configured port health check configuration

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: port-health-check-disable and port-health-check are mutually exclusive

responder-ca

Description: The trusted OCSP responder’s CA certificate filename.

Type: string

responder-cert

Description: The trusted OCSP responder’s certificate filename.

Type: string

sampling-enable

Description: sampling-enable is a JSON List . Please see below for sampling-enable

Type: List

url

Description: The OCSP server’s address in the following format: http://host[:port]/ .

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘request’: Request; ‘certificate-good’: Good Certificate Response; ‘certificate-revoked’: Revoked Certificate Response; ‘certificate-unknown’: Unknown Certificate Response; ‘timeout’: Timeout; ‘fail’: Handle OCSP response failed; ‘stapling-request’: OCSP Stapling Request Send; ‘stapling-certificate-good’: OCSP Stapling Good Certificate Response; ‘stapling-certificate-revoked’: OCSP Stapling Revoked Certificate Response; ‘stapling-certificate-unknown’: OCSP Stapling Unknown Certificate Response; ‘stapling-timeout’: OCSP Stapling Timeout; ‘stapling-fail’: Handle OCSP response failed;

Type: string

Supported Values: all, request, certificate-good, certificate-revoked, certificate-unknown, timeout, fail, stapling-request, stapling-certificate-good, stapling-certificate-revoked, stapling-certificate-unknown, stapling-timeout, stapling-fail

stats data

Counter Size Description
stapling-timeout 8 OCSP Stapling Timeout
stapling-fail 8 Handle OCSP response failed
certificate-revoked 8 Revoked Certificate Response
request 8 Request
stapling-certificate-revoked 8 OCSP Stapling Revoked Certificate Response
certificate-unknown 8 Unknown Certificate Response
stapling-certificate-unknown 8 OCSP Stapling Unknown Certificate Response
stapling-certificate-good 8 OCSP Stapling Good Certificate Response
timeout 8 Timeout
fail 8 Handle OCSP response failed
certificate-good 8 Good Certificate Response
stapling-request 8 OCSP Stapling Request Send