Skip to main content

Load CIFS local users, groups and group membership files from a URL

Contributors
PDFs

POST /protocols/cifs/users-and-groups/bulk-import/{svm.uuid}

Introduced In: 9.11

Loads CIFS local users,groups and group memberships file from the specified URL.

Important notes

Existing CIFS local users, groups, and group memberships will be replaced with the contents of the file.

Required properties

  • import_uri.path

  • decryption_password

Optional properties

  • import_uri.username

  • import_uri.password

  • vserver cifs users-and-groups import load-from-uri

Parameters

Name Type In Required Description

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When doing a POST, PATCH, or DELETE operation on a single record, the default is 0 seconds. This means that if an asynchronous operation is started, the server immediately returns HTTP code 202 (Accepted) along with a link to the job. If a non-zero value is specified for POST, PATCH, or DELETE operations, ONTAP waits that length of time to see if the job completes so it can return something other than 202.

  • Default value: 1

  • Max value: 120

  • Min value: 0

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

Request Body

Name Type Description

_links

_links

decryption_password

string

Password to decrypt the compressed file.

detailed_status

detailed_status

elements_ignored

integer

Number of elements ignored.

elements_imported

integer

Number of elements successfully imported.

import_uri

import_uri

state

string

Operation status.

status_uri

status_uri

svm

svm

SVM, applies only to SVM-scoped objects.
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "decryption_password": "string",
  "detailed_status": {
    "code": "6684732",
    "message": "string"
  },
  "elements_ignored": 0,
  "elements_imported": 0,
  "import_uri": {
    "password": "string",
    "path": "http://web.sample.com/web1/file1.7z",
    "username": "user1"
  },
  "state": "string",
  "status_uri": {
    "password": "string",
    "path": "http://web.sample.com/web1/file1.7z",
    "username": "user1"
  },
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

Response

Status: 202, Accepted
Name Type Description

job

job_link
Example response 
{
  "job": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "uuid": "string"
  }
}

Headers

Name Description Type

Location

Useful for tracking the resource location

string

Response

Status: 201, Created

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

655688

Invalid file decryption password. Valid password characters are: a-z, A-Z, and 0-9.

655660

This operation is only permitted on data SVMs.

655661

URI username, URI password and the file decryption password cannot exceed 128 characters.

655689

File decryption password cannot be empty.

655399

CIFS server does not exist.

655683

Domain Security Identifier is already present in Active Directory.

655685

Cluster is busy processing a local users and groups transition task.

655687

Unknown file schema version.

655690

Processing the import file failed. Check the file decryption password, compression format and content.

655691

Error occurred before processing the file. Verify the input parameters.

655692

Domain name that qualifies the local users and groups must match the CIFS server name.

655693

All local users and local groups must be prefixed with the NetBIOS domain name.

655693

Well-known user of group will not be present in this SVM.

655695

Group membership of the specified user will not be created.

655697

Failed processing a line of the bulk import file.

655698

Failed to parse a line of the bulk import file. Check the syntax and contents.

655699

Invalid number of elements in a line of the bulk import file.

655700

Failed processing a field index of a line in the input bulk import file.

655701

Unknown element type.

655702

Invalid URI.

655703

Failed to download the import file. Network error occurred.
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

detailed_status

Name Type Description

code

string

Code corresponding to the import status failure.

message

string

Detailed description of the import status.

import_uri

Name Type Description

password

string

Password of the specified URI.

path

string

URI from which to load the input file containing the CIFS local users and groups. The file must be encrypted using the 7zip utility. URI can be FTP or HTTP.

username

string

Username of the specified URI.

status_uri

Name Type Description

password

string

Password of the specified URI.

path

string

URI from which to load the input file containing the CIFS local users and groups. The file must be encrypted using the 7zip utility. URI can be FTP or HTTP.

username

string

Username of the specified URI.

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.

local_cifs_users_and_groups_import

Name Type Description

_links

_links

decryption_password

string

Password to decrypt the compressed file.

detailed_status

detailed_status

elements_ignored

integer

Number of elements ignored.

elements_imported

integer

Number of elements successfully imported.

import_uri

import_uri

state

string

Operation status.

status_uri

status_uri

svm

svm

SVM, applies only to SVM-scoped objects.
Name Type Description

_links

_links

uuid

string

The UUID of the asynchronous job that is triggered by a POST, PATCH, or DELETE operation.

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.