Retrieve all LDAP schemas
- PDF of this doc site
Collection of separate PDF docs
Creating your file...
GET /name-services/ldap-schemas
Introduced In: 9.11
Retrieves all the LDAP schemas.
Related ONTAP commands
-
vserver services name-service ldap client schema show
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
name |
string |
query |
False |
Filter by name
|
rfc2307.nis.netgroup |
string |
query |
False |
Filter by rfc2307.nis.netgroup |
rfc2307.nis.netgroup_triple |
string |
query |
False |
Filter by rfc2307.nis.netgroup_triple |
rfc2307.nis.mapentry |
string |
query |
False |
Filter by rfc2307.nis.mapentry |
rfc2307.nis.mapname |
string |
query |
False |
Filter by rfc2307.nis.mapname |
rfc2307.nis.object |
string |
query |
False |
Filter by rfc2307.nis.object |
rfc2307.cn.netgroup |
string |
query |
False |
Filter by rfc2307.cn.netgroup |
rfc2307.cn.group |
string |
query |
False |
Filter by rfc2307.cn.group |
rfc2307.member.nis_netgroup |
string |
query |
False |
Filter by rfc2307.member.nis_netgroup |
rfc2307.member.uid |
string |
query |
False |
Filter by rfc2307.member.uid |
rfc2307.attribute.gecos |
string |
query |
False |
Filter by rfc2307.attribute.gecos |
rfc2307.attribute.uid |
string |
query |
False |
Filter by rfc2307.attribute.uid |
rfc2307.attribute.uid_number |
string |
query |
False |
Filter by rfc2307.attribute.uid_number |
rfc2307.attribute.home_directory |
string |
query |
False |
Filter by rfc2307.attribute.home_directory |
rfc2307.attribute.login_shell |
string |
query |
False |
Filter by rfc2307.attribute.login_shell |
rfc2307.attribute.gid_number |
string |
query |
False |
Filter by rfc2307.attribute.gid_number |
rfc2307.attribute.user_password |
string |
query |
False |
Filter by rfc2307.attribute.user_password |
rfc2307.posix.group |
string |
query |
False |
Filter by rfc2307.posix.group |
rfc2307.posix.account |
string |
query |
False |
Filter by rfc2307.posix.account |
scope |
string |
query |
False |
Filter by scope |
rfc2307bis.maximum_groups |
integer |
query |
False |
Filter by rfc2307bis.maximum_groups
|
rfc2307bis.group_of_unique_names |
string |
query |
False |
Filter by rfc2307bis.group_of_unique_names |
rfc2307bis.unique_member |
string |
query |
False |
Filter by rfc2307bis.unique_member |
rfc2307bis.enabled |
boolean |
query |
False |
Filter by rfc2307bis.enabled |
global_schema |
boolean |
query |
False |
Filter by global_schema |
name_mapping.windows_to_unix.no_domain_prefix |
boolean |
query |
False |
Filter by name_mapping.windows_to_unix.no_domain_prefix |
name_mapping.windows_to_unix.object_class |
string |
query |
False |
Filter by name_mapping.windows_to_unix.object_class |
name_mapping.windows_to_unix.attribute |
string |
query |
False |
Filter by name_mapping.windows_to_unix.attribute |
name_mapping.account.unix |
string |
query |
False |
Filter by name_mapping.account.unix |
name_mapping.account.windows |
string |
query |
False |
Filter by name_mapping.account.windows |
owner.uuid |
string |
query |
False |
Filter by owner.uuid |
owner.name |
string |
query |
False |
Filter by owner.name |
comment |
string |
query |
False |
Filter by comment |
fields |
array[string] |
query |
False |
Specify the fields to return. |
max_records |
integer |
query |
False |
Limit the number of records returned. |
return_records |
boolean |
query |
False |
The default is true for GET calls. When set to false, only the number of records is returned.
|
return_timeout |
integer |
query |
False |
The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.
|
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
Response
Status: 200, Ok
Name | Type | Description |
---|---|---|
_links |
||
num_records |
integer |
Number of LDAP schema records. |
records |
array[ldap_schema] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"comment": "Schema based on Active Directory Services for UNIX (read-only).",
"global_schema": 1,
"name": "AD-SFU-v1",
"name_mapping": {
"account": {
"unix": "windowsAccount",
"windows": "windowsAccount"
},
"windows_to_unix": {
"attribute": "windowsAccount",
"no_domain_prefix": "",
"object_class": "User"
}
},
"owner": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"rfc2307": {
"attribute": {
"gecos": "name",
"gid_number": "msSFU30GidNumber",
"home_directory": "msSFU30HomeDirectory",
"login_shell": "msSFU30LoginShell",
"uid": "sAMAccountName",
"uid_number": "msSFU30UidNumber",
"user_password": "msSFU30Password"
},
"cn": {
"group": "cn",
"netgroup": "name"
},
"member": {
"nis_netgroup": "msSFU30MemberNisNetgroup",
"uid": "msSFU30MemberUid"
},
"nis": {
"mapentry": "msSFU30NisMapEntry",
"mapname": "msSFU30NisMapName",
"netgroup": "msSFU30NisNetGroup",
"netgroup_triple": "msSFU30MemberOfNisNetgroup",
"object": "msSFU30NisObject"
},
"posix": {
"account": "User",
"group": "Group"
}
},
"rfc2307bis": {
"enabled": "",
"group_of_unique_names": "groupOfUniqueNames",
"maximum_groups": 256,
"unique_member": "uniqueMember"
},
"scope": "string",
"template": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "AD-SFU-v1"
}
}
]
}
Error
Status: Default, Error
Name | Type | Description |
---|---|---|
error |
Example error
{
"error": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist",
"target": "uuid"
}
}
Definitions
See Definitions
href
Name | Type | Description |
---|---|---|
href |
string |
_links
Name | Type | Description |
---|---|---|
next |
||
self |
_links
Name | Type | Description |
---|---|---|
self |
ldap_schema_account
Name | Type | Description |
---|---|---|
unix |
string |
Attribute name used to retrieve UNIX account information. |
windows |
string |
Attribute name used to retrieve Windows account information for a UNIX user account. |
windows_to_unix
Name | Type | Description |
---|---|---|
attribute |
string |
Attribute name used to retrieve the UNIX account information for a Windows user account. |
no_domain_prefix |
boolean |
Indicates whether or not the name for Windows to UNIX name mapping should have a domain prefix. |
object_class |
string |
Name used to represent the windowsToUnix object class. |
ldap_schema_name_mapping
Name | Type | Description |
---|---|---|
account |
||
windows_to_unix |
owner
SVM, applies only to SVM-scoped objects.
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
The name of the SVM. This field cannot be specified in a PATCH method. |
uuid |
string |
The unique identifier of the SVM. This field cannot be specified in a PATCH method. |
attribute
Name | Type | Description |
---|---|---|
gecos |
string |
RFC 2307 gecos attribute. |
gid_number |
string |
RFC 2307 gidNumber attribute. |
home_directory |
string |
RFC 2307 homeDirectory attribute. |
login_shell |
string |
RFC 2307 loginShell attribute. |
uid |
string |
RFC 1274 userid attribute used by RFC 2307 as UID. |
uid_number |
string |
RFC 2307 uidNumber attribute. |
user_password |
string |