Skip to main content
A newer release of this product is available.

Retrieve the name mapping configuration for an SVM

Contributors
PDFs

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

Introduced In: 9.6

Retrieves the name mapping configuration of an SVM.

  • vserver name-mapping show

Learn more

Parameters

Name Type In Required Description

direction

string

path

True

Direction

index

integer

path

True

Position of the entry in the list

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
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
Example response 
{
  "_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, Error
Name Type Description

error

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

href

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

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.