aam authentication server windows instance

Configure an authentication-server profile for a Windows server for either Kerberos, NTLM, or Windows Integrated Authentication.

instance Specification

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

Operations Allowed:

Operation Method URI Payload

Create Object

POST

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

instance Attributes

Create List

POST

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

instance Attributes

Get Object

GET

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

instance Attributes

Get List

GET

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

instance-list

Modify Object

POST

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

instance Attributes

Replace Object

PUT

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

instance Attributes

Replace List

PUT

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

instance-list

Delete Object

DELETE

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

instance Attributes

Get Stats

GET

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

stats data

instance-list

instance-list is JSON List of instance Attributes

instance-list : [

instance Attributes

auth-protocol

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

Type: Object

health-check

Description: Enable the port’s health check.

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 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: Specify the name of an existing health check monitor.

Type: string

Reference Object: /axapi/v3/health/monitor

host

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

Type: Object

name

Description: Specify the Windows authentication server name.

Type: string

Format: string-rlx

Required: Yes

realm

Description: URL of the host realm for the authentication 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: Specifies connection timeout to the server.

Type: number

Range: 1-255

Default: 10

uuid

Description: uuid of the object

Type: string

host

Specification
Type object

hostip

Description: Hostname or IPv4 address of the Windows server.

Type: string

Format: host

Mutual Exclusion: hostip and hostipv6 are mutually exclusive

hostipv6

Description: IPv6 address of the RADIUS server.

Type: string

Format: ipv6-address

Mutual Exclusion: hostipv6 and hostip are mutually exclusive

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

auth-protocol

Specification
Type object

kerberos-disable

Description: Disable Kerberos protocol.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

kerberos-port

Description: Specify the Kerberos port.

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

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 the NTLM version.

Type: number

Range: 1-2

Default: 2

stats data

Counter Size Description
krb_send_req_success 8 Kerberos Request
ntlm_auth_success 8 NTLM Authentication Success
ntlm_prepare_req_error 8 NTLM Prepare Request Error
ntlm_other_error 8 NTLM Other Error
ntlm_auth_failure 8 NTLM Authentication Failure
krb_timeout_error 8 Kerberos Timeout
ntlm_session_setup_success 8 NTLM Session Setup Success
ntlm_timeout_error 8 NTLM Timeout
krb_other_error 8 Kerberos Other Error
ntlm_proto_nego_failure 8 NTLM Protocol Negotiation Failure
ntlm_session_setup_failure 8 NTLM Session Setup Failure
ntlm_prepare_req_success 8 NTLM Prepare Request Success
krb_get_resp_success 8 Kerberos Response
ntlm_proto_nego_success 8 NTLM Protocol Negotiation Success