aam authentication server windows instance¶
“Windows Server, using Kerberos or NTLM for authentication”
instance Specification¶
Type
Collection
Object Key(s)
name
Collection Name
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
Operations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/aam/authentication/server/windows/instance | ||
Create List | POST | /axapi/v3/aam/authentication/server/windows/instance | ||
Get Object | GET | /axapi/v3/aam/authentication/server/windows/instance/{name} | ||
Get List | GET | /axapi/v3/aam/authentication/server/windows/instance | ||
Modify Object | POST | /axapi/v3/aam/authentication/server/windows/instance/{name} | ||
Replace Object | PUT | /axapi/v3/aam/authentication/server/windows/instance/{name} | ||
Replace List | PUT | /axapi/v3/aam/authentication/server/windows/instance | ||
Delete Object | DELETE | /axapi/v3/aam/authentication/server/windows/instance/{name} |
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 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
Maximum Length: 63 characters
Maximum Length: 1 characters
Refernce Object: /axapi/v3/health/monitor
host
Description: host is a JSON Block. Please see below for host
Type: Object
name
Description Specify Windows authentication server name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
realm
Description Specify realm of Windows server
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
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
Maximum Length: 64 characters
Maximum Length: 1 characters
host¶
Specification
Type
object
hostip
Description Specify the Windows server’s hostname(Length 1-31) or IP address
Type: string
Format: host
Maximum Length: 31 characters
Maximum Length: 1 characters
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
auth-protocol¶
Specification
Type
object
kerberos-disable
Description Disable Kerberos authentication protocol
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
kerberos-password-change-port
Description Specify the Kerbros password change port, default is 464
Type: number
Range: 1-65534
Default: 464
kerberos-port
Description Specify the Kerberos port, default is 88
Type: number
Range: 1-65534
Default: 88
kport-hm
Description Check Kerberos port’s health status
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: kport-hm and kport-hm-disable are mutually exclusive
Refernce 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
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: ntlm-health-check and ntlm-health-check-disable are mutually exclusive
Refernce 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 |
|
|---|---|---|---|
krb_send_req_success |
8 |
Kerberos Request |
|
ntlm_other_error |
8 |
NTLM Other Error |
|
ntlm_auth_success |
8 |
NTLM Authentication Success |
|
krb_timeout_error |
8 |
Kerberos Timeout |
|
ntlm_prepare_req_error |
8 |
NTLM Prepare Request Error |
|
ntlm_auth_failure |
8 |
NTLM Authentication Failure |
|
krb_pw_change_success |
8 |
Kerberos password change success |
|
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 |
|
krb_pw_expiry |
8 |
Kerberos password expiry |
|
ntlm_session_setup_failure |
8 |
NTLM Session Setup Failure |
|
krb_pw_change_failure |
8 |
Kerberos password change failure |
|
krb_get_resp_success |
8 |
Kerberos Response |
|
ntlm_proto_nego_success |
8 |
NTLM Protocol Negotiation Success |
|
ntlm_prepare_req_success |
8 |
NTLM Prepare Request Success |