Skip to main content

Update the name mapping configuration for an SVM

Contributors

PATCH /name-services/name-mappings/{svm.uuid}/{direction}/{index}

Introduced In: 9.6

Updates the name mapping configuration of an SVM. The positions can be swapped by providing the new_index property. Swapping is not allowed for entries that have client_match property configured.

  • vserver name-mapping modify

  • vserver name-mapping swap

Parameters

Name Type In Required Description

direction

string

path

True

Direction

index

integer

path

True

Position of the entry in the list

new_index

integer

query

False

New position of the Index after a swap is completed.

  • Introduced in: 9.7

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

Request Body

Name Type Description

_links

_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:

  • As an IPv4 address with a subnet mask expressed as a number of bits; for instance, 10.1.12.0/24

  • As an IPv6 address with a subnet mask expressed as a number of bits; for instance, fd20:8b1e:b255:4071::/64

  • As an IPv4 address with a network mask; for instance, 10.1.16.0/255.255.255.0

  • As a hostname

direction

string

Direction in which the name mapping is applied. The possible values are:

  • krb_unix - Kerberos principal name to UNIX user name

  • win_unix - Windows user name to UNIX user name

  • unix_win - UNIX user name to Windows user name mapping

  • s3_unix - S3 user name to UNIX user name mapping

  • s3_win - S3 user name to Windows user name mapping

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

svm

SVM, applies only to SVM-scoped objects.

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: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

65798185

Failed to resolve the specified hostname

65798179

Cannot swap entries because one or both entries have host name or address configured.

Delete and re-create the new entry at the specified position.

schema: $ref: "#/definitions/error_response"

Definitions

See Definitions

href

Name Type Description

href

string

Name Type Description

self

href

svm

SVM, applies only to SVM-scoped objects.

Name Type Description

_links

_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.

name_mapping

Name mapping is used to map CIFS identities to UNIX identities, Kerberos identities to UNIX identities, UNIX identities to CIFS identities, S3 to UNIX identities and S3 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, CIFS client or an S3 client.

Name Type Description

_links

_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:

  • As an IPv4 address with a subnet mask expressed as a number of bits; for instance, 10.1.12.0/24

  • As an IPv6 address with a subnet mask expressed as a number of bits; for instance, fd20:8b1e:b255:4071::/64

  • As an IPv4 address with a network mask; for instance, 10.1.16.0/255.255.255.0

  • As a hostname

direction

string

Direction in which the name mapping is applied. The possible values are:

  • krb_unix - Kerberos principal name to UNIX user name

  • win_unix - Windows user name to UNIX user name

  • unix_win - UNIX user name to Windows user name mapping

  • s3_unix - S3 user name to UNIX user name mapping

  • s3_win - S3 user name to Windows user name mapping

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

svm

SVM, applies only to SVM-scoped objects.