ldap
Suggest changes
PDFs
ldap-check-get-iter
This ONTAPI call does not have an equivalent REST API call.
ldap-client-create
POST /api/name-services/ldap
Note: REST API doesn't treat LDAP client create as an independent operation, but LDAP client and LDAP config are created using LDAP POST. /api/security/authentication/cluster/ldap is used to create Cluster LDAP configurations.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
ad-domain |
ad_domain |
|
base-dn |
base_dn |
|
base-scope |
base_scope |
|
bind-as-cifs-server |
No REST Equivalent |
|
bind-dn |
bind_dn |
|
bind-password |
bind_password |
|
group-dn |
No REST Equivalent |
|
group-membership-filter |
No REST Equivalent |
|
group-scope |
No REST Equivalent |
|
is-netgroup-byhost-enabled |
No REST Equivalent |
|
ldap-client-config |
No REST Equivalent |
|
ldap-servers |
servers |
|
min-bind-level |
min_bind_level |
|
netgroup-byhost-dn |
No REST Equivalent |
|
netgroup-byhost-scope |
No REST Equivalent |
|
netgroup-dn |
No REST Equivalent |
|
netgroup-scope |
No REST Equivalent |
|
obs-password |
No REST Equivalent |
|
preferred-ad-servers |
preferred_ad_servers |
|
query-timeout |
No REST Equivalent |
|
referral-enabled |
No REST Equivalent |
|
return-record |
?return_records=true |
|
schema |
schema |
|
servers |
No REST Equivalent |
|
session-security |
session_security |
|
tcp-port |
port |
|
use-start-tls |
use_start_tls |
|
user-dn |
No REST Equivalent |
|
user-scope |
No REST Equivalent |
ldap-client-delete
DELETE /api/name-services/ldap/{svm.uuid}
Note: REST API doesn't treat LDAP client delete as an independent operation, but LDAP client and LDAP config are deleted using LDAP DELETE. /api/security/authentication/cluster/ldap is used to delete Cluster LDAP configurations
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
ldap-client-config |
No REST Equivalent |
ldap-client-get-iter
GET /api/name-services/ldap
Note: REST API doesn't have a separate LDAP client get operation, but LDAP client config can be fetched using LDAP GET.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
ad-domain |
ad_domain |
|
base-dn |
base_dn |
|
base-scope |
base_scope |
|
bind-as-cifs-server |
No REST Equivalent |
|
bind-dn |
bind_dn |
|
bind-password |
bind_password |
|
group-dn |
No REST Equivalent |
|
group-membership-filter |
No REST Equivalent |
|
group-scope |
No REST Equivalent |
|
is-netgroup-byhost-enabled |
No REST Equivalent |
|
is-owner |
No REST Equivalent |
|
ldap-client-config |
No REST Equivalent |
|
ldap-servers |
servers |
|
min-bind-level |
min_bind_level |
|
netgroup-byhost-dn |
No REST Equivalent |
|
netgroup-byhost-scope |
No REST Equivalent |
|
netgroup-dn |
No REST Equivalent |
|
netgroup-scope |
No REST Equivalent |
|
obs-password |
No REST Equivalent |
|
preferred-ad-servers |
preferred_ad_servers |
|
query-timeout |
No REST Equivalent |
|
referral-enabled |
No REST Equivalent |
|
schema |
schema |
|
servers |
No REST Equivalent |
|
session-security |
session_security |
|
skip-config-validation |
No REST Equivalent |
|
tcp-port |
port |
|
use-start-tls |
use_start_tls |
|
user-dn |
No REST Equivalent |
|
user-scope |
No REST Equivalent |
|
vserver |
svm.name |
|
max-records |
max_records |
The maximum number of records to return before paging |
ldap-client-modify
PATCH /api/name-services/ldap/{svm.uuid}
Note: REST API doesn't have a separate LDAP client modify operation, but LDAP client can be modified using LDAP PATCH. /api/security/authentication/cluster/ldap is used to modify Cluster LDAP configurations.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
ad-domain |
ad_domain |
|
base-dn |
base_dn |
|
base-scope |
base_scope |
|
bind-as-cifs-server |
No REST Equivalent |
|
bind-dn |
bind_dn |
|
bind-password |
bind_password |
|
group-dn |
No REST Equivalent |
|
group-membership-filter |
No REST Equivalent |
|
group-scope |
No REST Equivalent |
|
is-netgroup-byhost-enabled |
No REST Equivalent |
|
ldap-client-config |
No REST Equivalent |
|
ldap-servers |
servers |
|
min-bind-level |
min_bind_level |
|
netgroup-byhost-dn |
No REST Equivalent |
|
netgroup-byhost-scope |
No REST Equivalent |
|
netgroup-dn |
No REST Equivalent |
|
netgroup-scope |
No REST Equivalent |
|
obs-password |
No REST Equivalent |
|
preferred-ad-servers |
preferred_ad_servers |
|
query-timeout |
No REST Equivalent |
|
referral-enabled |
No REST Equivalent |
|
schema |
schema |
|
servers |
No REST Equivalent |
|
session-security |
session_security |
|
skip-config-validation |
No REST Equivalent |
|
tcp-port |
port |
|
use-start-tls |
use_start_tls |
|
user-dn |
No REST Equivalent |
|
user-scope |
No REST Equivalent |
ldap-client-schema-copy
This ONTAPI call does not have an equivalent REST API call.
ldap-client-schema-delete
This ONTAPI call does not have an equivalent REST API call.
ldap-client-schema-get-iter
This ONTAPI call does not have an equivalent REST API call.
ldap-client-schema-modify
This ONTAPI call does not have an equivalent REST API call.
ldap-config-create
POST /api/name-services/ldap
Note: /api/security/authentication/cluster/ldap is used to create Cluster LDAP configurations.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
client-config |
No REST Equivalent |
|
client-enabled |
No REST Equivalent |
|
return-record |
?return_records=true |
|
skip-config-validation |
No REST Equivalent |
ldap-config-delete
DELETE /api/name-services/ldap/{svm.uuid}
Note: /api/security/authentication/cluster/ldap is used to delete Cluster LDAP configurations.
There are no attributes defined for this ONTAPI call.
ldap-config-get-iter
GET /api/name-services/ldap
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
client-config |
No REST Equivalent |
|
client-enabled |
No REST Equivalent |
|
skip-config-validation |
No REST Equivalent |
|
vserver |
svm.name |
|
max-records |
max_records |
The maximum number of records to return before paging |
ldap-config-modify
PATCH /api/name-services/ldap/{svm.uuid}
Note: /api/security/authentication/cluster/ldap is used to modify Cluster LDAP configurations.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
client-config |
No REST Equivalent |
|
client-enabled |
No REST Equivalent |
|
skip-config-validation |
No REST Equivalent |