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

Create a home directory search path

Contributors
PDFs

POST /protocols/cifs/home-directory/search-paths

Creates a home directory search path.

Required properties

  • svm.uuid or svm.name - Existing SVM in which to create the home directory search path.

  • path - Path in the owning SVM namespace that is used to search for home directories.

  • cifs server home-directory search-path add

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.

Request Body

Name Type Description

index

integer

The position in the list of paths that is searched to find the home directory of the CIFS client. Not available in POST.

path

string

The file system path that is searched to find the home directory of the CIFS client.

svm

svm
Example request 
{
  "index": 0,
  "path": "/HomeDirectory/EngDomain",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

Response

Status: 201, Created
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[cifs_search_path]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": {
    "index": 0,
    "path": "/HomeDirectory/EngDomain",
    "svm": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "svm1",
      "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
    }
  }
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

655551

Invalid home-directory search-path path

655462

The specified path is an invalid file-type
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.

cifs_search_path

This is a list of CIFS home directory search paths. When a CIFS client connects to a home directory share, these paths are searched in the order indicated by the position field to find the home directory of the connected CIFS client.

Name Type Description

index

integer

The position in the list of paths that is searched to find the home directory of the CIFS client. Not available in POST.

path

string

The file system path that is searched to find the home directory of the CIFS client.

svm

svm

_links

Name Type Description

next

href

self

href

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.