Create the hostname mappings for an SVM
POST /name-services/name-mappings
Creates name mappings for an SVM.
Required properties
-
svm.uuid
orsvm.name
- Existing SVM in which to create the name mapping. -
index
- Name mapping's position in the priority list. -
direction
- Direction of the name mapping. -
pattern
- Pattern to match to. Maximum length is 256 characters. -
replacement
- Replacement pattern to match to. Maximum length is 256 characters.
Recommended optional properties
-
client_match
- Hostname or IP address added to match the pattern to the client's workstation IP address.
Related ONTAP commands
-
vserver name-mapping create
-
vserver name-mapping insert
Learn more
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
return_records |
boolean |
query |
False |
The default is false. If set to true, the records are returned. |
Request Body
Name | Type | Description |
---|---|---|
_links |
||
client_match |
string |
Client workstation IP Address which is matched when searching for the pattern. You can specify the value in any of the following formats:
|
direction |
string |
Direction in which the name mapping is applied. The possible values are:
|
index |
integer |
Position in the list of name mappings. |
pattern |
string |
Pattern used to match the name while searching for a name that can be used as a replacement. The pattern is a UNIX-style regular expression. Regular expressions are case-insensitive when mapping from Windows to UNIX, and they are case-sensitive for mappings from Kerberos to UNIX and UNIX to Windows. |
replacement |
string |
The name that is used as a replacement, if the pattern associated with this entry matches. |
svm |
Example request
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"client_match": "10.254.101.111/28",
"direction": "win_unix",
"index": 1,
"pattern": "ENGCIFS_AD_USER",
"replacement": "unix_user1",
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
}
}
Response
Status: 201, Created
Name | Type | Description |
---|---|---|
_links |
||
num_records |
integer |
Number of records |
records |
array[name_mapping] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"records": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"client_match": "10.254.101.111/28",
"direction": "win_unix",
"index": 1,
"pattern": "ENGCIFS_AD_USER",
"replacement": "unix_user1",
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
}
}
]
}
Error
Status: Default
ONTAP Error Response Codes
Error Code | Description |
---|---|
65798185 |
Failed to resolve the specified hostname |
65798149 |
Invalid index for the name mapping entry |
2621706 |
The specified svm.uuid and svm.name refer to different SVMs |
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 |
---|---|---|
self |
svm
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
The name of the SVM. |
uuid |
string |
The unique identifier of the SVM. |
name_mapping
Name mapping is used to map CIFS identities to UNIX identities, Kerberos identities to UNIX identities, and UNIX identities to CIFS identities. It needs this information to obtain user credentials and provide proper file access regardless of whether they are connecting from an NFS client or a CIFS client.
Name | Type | Description |
---|---|---|
_links |
||
client_match |
string |
Client workstation IP Address which is matched when searching for the pattern. You can specify the value in any of the following formats:
|
direction |
string |
Direction in which the name mapping is applied. The possible values are:
|
index |
integer |
Position in the list of name mappings. |
pattern |
string |
Pattern used to match the name while searching for a name that can be used as a replacement. The pattern is a UNIX-style regular expression. Regular expressions are case-insensitive when mapping from Windows to UNIX, and they are case-sensitive for mappings from Kerberos to UNIX and UNIX to Windows. |
replacement |
string |
The name that is used as a replacement, if the pattern associated with this entry matches. |
svm |
_links
Name | Type | Description |
---|---|---|
next |
||
self |
error_arguments
Name | Type | Description |
---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
error
Name | Type | Description |
---|---|---|
arguments |
array[error_arguments] |
Message arguments |
code |
string |
Error code |
message |
string |
Error message |
target |
string |
The target parameter that caused the error. |