aam authentication server windows

“Windows Server

windows Specification

Type Configuration Resource
Element Name windows
Element URI /axapi/v3/aam/authentication/server/windows
Element Attributes windows_attributes
Statistics Data URI /axapi/v3/aam/authentication/server/windows/stats
Schema windows schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/aam/authentication/server/windows

windows Attributes

Get Object

GET

/axapi/v3/aam/authentication/server/windows

windows Attributes

Modify Object

POST

/axapi/v3/aam/authentication/server/windows

windows Attributes

Replace Object

PUT

/axapi/v3/aam/authentication/server/windows

windows Attributes

Delete Object

DELETE

/axapi/v3/aam/authentication/server/windows

windows Attributes

Get Stats

GET

/axapi/v3/aam/authentication/server/windows/stats

stats data

windows Attributes

instance-list

Description: instance-list is a JSON List . Please see below for instance-list

Type: List

Reference Object: /axapi/v3/aam/authentication/server/windows/instance/{name}

sampling-enable

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

Type: List

uuid

Description: uuid of the object

Type: string

sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘kerberos-request-send’: Total Kerberos Request; ‘kerberos-response-get’: Total Kerberos Response; ‘kerberos-timeout-error’: Total Kerberos Timeout; ‘kerberos-other-error’: Total Kerberos Other Error; ‘ntlm-authentication-success’: Total NTLM Authentication Success; ‘ntlm-authentication-failure’: Total NTLM Authentication Failure; ‘ntlm-proto-negotiation-success’: Total NTLM Protocol Negotiation Success; ‘ntlm-proto-negotiation-failure’: Total NTLM Protocol Negotiation Failure; ‘ntlm-session-setup-success’: Total NTLM Session Setup Success; ‘ntlm-session-setup-failed’: Total NTLM Session Setup Failure; ‘kerberos-request-normal’: Total Kerberos Normal Request; ‘kerberos-request-dropped’: Total Kerberos Dropped Request; ‘kerberos-response-success’: Total Kerberos Success Response; ‘kerberos-response-failure’: Total Kerberos Failure Response; ‘kerberos-response-error’: Total Kerberos Error Response; ‘kerberos-response-timeout’: Total Kerberos Timeout Response; ‘kerberos-response-other’: Total Kerberos Other Response; ‘kerberos-job-start-error’: Total Kerberos Job Start Error; ‘kerberos-polling-control-error’: Total Kerberos Polling Control Error; ‘ntlm-prepare-req-success’: Total NTLM Prepare Request Success; ‘ntlm-prepare-req-failed’: Total NTLM Prepare Request Failed; ‘ntlm-timeout-error’: Total NTLM Timeout; ‘ntlm-other-error’: Total NTLM Other Error; ‘ntlm-request-normal’: Total NTLM Normal Request; ‘ntlm-request-dropped’: Total NTLM Dropped Request; ‘ntlm-response-success’: Total NTLM Success Response; ‘ntlm-response-failure’: Total NTLM Failure Response; ‘ntlm-response-error’: Total NTLM Error Response; ‘ntlm-response-timeout’: Total NTLM Timeout Response; ‘ntlm-response-other’: Total NTLM Other Response; ‘ntlm-job-start-error’: Total NTLM Job Start Error; ‘ntlm-polling-control-error’: Total NTLM Polling Control Error;

Type: string

Supported Values: all, kerberos-request-send, kerberos-response-get, kerberos-timeout-error, kerberos-other-error, ntlm-authentication-success, ntlm-authentication-failure, ntlm-proto-negotiation-success, ntlm-proto-negotiation-failure, ntlm-session-setup-success, ntlm-session-setup-failed, kerberos-request-normal, kerberos-request-dropped, kerberos-response-success, kerberos-response-failure, kerberos-response-error, kerberos-response-timeout, kerberos-response-other, kerberos-job-start-error, kerberos-polling-control-error, ntlm-prepare-req-success, ntlm-prepare-req-failed, ntlm-timeout-error, ntlm-other-error, ntlm-request-normal, ntlm-request-dropped, ntlm-response-success, ntlm-response-failure, ntlm-response-error, ntlm-response-timeout, ntlm-response-other, ntlm-job-start-error, ntlm-polling-control-error

instance-list

Specification
Type list
Block object keys

auth-protocol

Description: auth-protocol is a JSON Block . Please see below for l1084_auth-protocol

Type: Object

health-check

Description: Check server’s health status

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 configured health check configuration

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: Health monitor name

Type: string

Reference Object: /axapi/v3/health/monitor

host

Description: host is a JSON Block . Please see below for l1084_host

Type: Object

name

Description: Specify Windows authentication server name

Type: string

Format: string-rlx

realm

Description: Specify realm of Windows server

Type: string

sampling-enable

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

Type: List

support-apacheds-kdc

Description: Enable weak cipher (DES CRC/MD5/MD4) and merge AS-REQ in single packet

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

timeout

Description: Specify connection timeout to server, default is 10 seconds

Type: number

Range: 1-255

Default: 10

uuid

Description: uuid of the object

Type: string

instance-list.host

Specification
Type object

hostip

Description: Specify the Windows server’s hostname(Length 1-31) or IP address

Type: string

Format: host

Mutual Exclusion: hostip and hostipv6 are mutually exclusive

hostipv6

Description: Specify the Windows server’s IPV6 address

Type: string

Format: ipv6-address

Mutual Exclusion: hostipv6 and hostip are mutually exclusive

instance-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘krb_send_req_success’: Kerberos Request; ‘krb_get_resp_success’: Kerberos Response; ‘krb_timeout_error’: Kerberos Timeout; ‘krb_other_error’: Kerberos Other Error; ‘ntlm_proto_nego_success’: NTLM Protocol Negotiation Success; ‘ntlm_proto_nego_failure’: NTLM Protocol Negotiation Failure; ‘ntlm_session_setup_success’: NTLM Session Setup Success; ‘ntlm_session_setup_failure’: NTLM Session Setup Failure; ‘ntlm_prepare_req_success’: NTLM Prepare Request Success; ‘ntlm_prepare_req_error’: NTLM Prepare Request Error; ‘ntlm_auth_success’: NTLM Authentication Success; ‘ntlm_auth_failure’: NTLM Authentication Failure; ‘ntlm_timeout_error’: NTLM Timeout; ‘ntlm_other_error’: NTLM Other Error;

Type: string

Supported Values: all, krb_send_req_success, krb_get_resp_success, krb_timeout_error, krb_other_error, ntlm_proto_nego_success, ntlm_proto_nego_failure, ntlm_session_setup_success, ntlm_session_setup_failure, ntlm_prepare_req_success, ntlm_prepare_req_error, ntlm_auth_success, ntlm_auth_failure, ntlm_timeout_error, ntlm_other_error

instance-list.auth-protocol

Specification
Type object

kerberos-disable

Description: Disable Kerberos authentication protocol

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

kerberos-port

Description: Specify the Kerbros port, default is 88

Type: number

Range: 1-65534

Default: 88

kport-hm

Description: Check Kerberos port’s health status

Type: string

Mutual Exclusion: kport-hm and kport-hm-disable are mutually exclusive

Reference Object: /axapi/v3/health/monitor

kport-hm-disable

Description: Disable configured Kerberos port health check configuration

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: kport-hm-disable and kport-hm are mutually exclusive

ntlm-disable

Description: Disable NTLM authentication protocol

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ntlm-health-check

Description: Check NTLM port’s health status

Type: string

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

Reference Object: /axapi/v3/health/monitor

ntlm-health-check-disable

Description: Disable configured NTLM port health check configuration

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

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

ntlm-version

Description: Specify NTLM version, default is 2

Type: number

Range: 1-2

Default: 2

stats data

Counter Size Description
ntlm-response-error 8 Total NTLM Error Response
ntlm-proto-negotiation-failure 8 Total NTLM Protocol Negotiation Failure
ntlm-session-setup-failed 8 Total NTLM Session Setup Failure
ntlm-polling-control-error 8 Total NTLM Polling Control Error
kerberos-other-error 8 Total Kerberos Other Error
kerberos-timeout-error 8 Total Kerberos Timeout
kerberos-job-start-error 8 Total Kerberos Job Start Error
ntlm-proto-negotiation-success 8 Total NTLM Protocol Negotiation Success
ntlm-other-error 8 Total NTLM Other Error
ntlm-job-start-error 8 Total NTLM Job Start Error
ntlm-prepare-req-success 8 Total NTLM Prepare Request Success
ntlm-response-failure 8 Total NTLM Failure Response
kerberos-polling-control-error 8 Total Kerberos Polling Control Error
ntlm-prepare-req-failed 8 Total NTLM Prepare Request Failed
ntlm-request-normal 8 Total NTLM Normal Request
ntlm-authentication-success 8 Total NTLM Authentication Success
ntlm-response-timeout 8 Total NTLM Timeout Response
ntlm-authentication-failure 8 Total NTLM Authentication Failure
kerberos-request-send 8 Total Kerberos Request
kerberos-request-normal 8 Total Kerberos Normal Request
ntlm-response-other 8 Total NTLM Other Response
kerberos-request-dropped 8 Total Kerberos Dropped Request
kerberos-response-other 8 Total Kerberos Other Response
ntlm-session-setup-success 8 Total NTLM Session Setup Success
kerberos-response-error 8 Total Kerberos Error Response
kerberos-response-success 8 Total Kerberos Success Response
ntlm-request-dropped 8 Total NTLM Dropped Request
kerberos-response-timeout 8 Total Kerberos Timeout Response
kerberos-response-get 8 Total Kerberos Response
ntlm-timeout-error 8 Total NTLM Timeout
kerberos-response-failure 8 Total Kerberos Failure Response
ntlm-response-success 8 Total NTLM Success Response