Skip to main content

Update a UNIX symbolic link mapping for CIFS clients

Contributors
PDFs

PATCH /protocols/cifs/unix-symlink-mapping/{svm.uuid}/{unix_path}

Introduced In: 9.6

Updates the UNIX symbolic link mapping for CIFS clients.

  • vserver cifs symlink modify

Learn more

Parameters

Name Type In Required Description

unix_path

string

path

True

UNIX symbolic link path

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

Request Body

Name Type Description

_links

_links

svm

svm

SVM, applies only to SVM-scoped objects.

target

cifs_target

unix_path

string

Specifies the UNIX path prefix to be matched for the mapping.
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "target": {
    "locality": "string",
    "path": "/dir1/dir2/",
    "server": "ENGCIFS",
    "share": "ENG_SHARE"
  },
  "unix_path": "/mnt/eng_volume/"
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

655437

Failed to modify the symlink mapping with locality "local" because the target share does not exist for the specified SVM

655573

Failed to modify the symlink mapping to target path because it contains illegal characters or is too long

655575

Failed to modify the symlink mapping to target server because it contains illegal characters or is too long

655547

Failed to modify symlink mapping because administrative share cannot be used as target share

656481

Failed to modify the widelink because the target share does not exist for the specified SVM
Name Type Description

error

returned_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

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.

cifs_target

Name Type Description

home_directory

boolean

Specify if the destination share is a home directory.

locality

string

Specifies whether the CIFS symbolic link is a local link or wide link. The following values are supported:

  • local - Local symbolic link maps only to the same CIFS share.

  • widelink - Wide symbolic link maps to any CIFS share on the network.

path

string

Specifies the CIFS path on the destination to which the symbolic link maps. The final path is generated by concatenating the CIFS server name, the share name, the cifs-path and the remaining path in the symbolic link left after the prefix match. This value is specified by using a UNIX-style path name. The trailing forward slash is required for the full path name to be properly interpreted.

server

string

Specifies the destination CIFS server where the UNIX symbolic link is pointing. This field is mandatory if the locality of the symbolic link is 'widelink'. You can specify the value in any of the following formats:

  • DNS name of the CIFS server.

  • IP address of the CIFS server.

  • NetBIOS name of the CIFS server.

share

string

Specifies the CIFS share name on the destination CIFS server to which the UNIX symbolic link is pointing.

ONTAP allows for both CIFS and NFS access to the same datastore. This datastore can contain symbolic links created by UNIX clients which can point anywhere from the perspective of the UNIX client. To Access such UNIX symlink from CIFS share, we need to create a CIFS symbolic link path mapping from a UNIX symlink and target it as a CIFS path.

Name Type Description

_links

_links

svm

svm

SVM, applies only to SVM-scoped objects.

target

cifs_target

unix_path

string

Specifies the UNIX path prefix to be matched for the mapping.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

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