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

Retrieve UNIX symbolic link mappings for CIFS clients

Contributors
PDFs

GET /protocols/cifs/unix-symlink-mapping

Introduced In: 9.6

Retrieves UNIX symbolic link mappings for CIFS clients.

  • vserver cifs symlink show

Learn more

Parameters

Name Type In Required Description

unix_path

string

query

False

Filter by unix_path

  • maxLength: 256

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

target.path

string

query

False

Filter by target.path

  • maxLength: 256

target.home_directory

boolean

query

False

Filter by target.home_directory

target.share

string

query

False

Filter by target.share

  • maxLength: 80

target.server

string

query

False

Filter by target.server

  • maxLength: 45

target.locality

string

query

False

Filter by target.locality

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
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/"
    }
  ]
}

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

next

href

self

href

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

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

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

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.