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

Create a UNIX symbolic link mapping for a CIFS client

Contributors
PDFs

POST /protocols/cifs/unix-symlink-mapping

Introduced In: 9.6

Creates a UNIX symbolic link mapping for a CIFS client.

Required properties

  • svm.uuid or svm.name - Existing SVM in which to create the CIFS unix-symlink-mapping.

  • unix_path - UNIX path to which the CIFS symlink mapping to be created.

  • target.share - CIFS share name on the destination CIFS server to which the UNIX symbolic link is pointing.

  • target.path - CIFS path on the destination to which the symbolic link maps.

Default property values

  • target.server - Local_NetBIOS_Server_Name

  • locality - local

  • home_directory - false

  • vserver cifs symlink create

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.

  • Default value:

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: 201, Created
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[cifs_symlink_mapping]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_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/"
    }
  ]
}

Headers

Name Description Type

Location

Useful for tracking the resource location

string

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

655654

Must specify the target CIFS share while creating path mapping entries with localities "local" or "widelink"

655572

The target path contains illegal characters or is too long

655574

The target server contains illegal characters or is too long

655436

If the locality is "local", the target server must be blank or must match the CIFS NetBIOS name for given SVM

655439

The Specified target server is local CIFS server for given SVM but the locality is specified as "widelink"

655546

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

655437

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

655429

UNIX path must begin and end with a "/"

655430

Target path must begin and end with a "/"

655399

Failed to get the CIFS server for 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.

_links

Name Type Description

next

href

self

href

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.