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

Upload the bulk-import status of an SVM to a URI

PDFs

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

Introduced In: 9.11

Upload the status of the bulk-import of the specified SVM to the specified URI.

Important notes

  • Only the status of the last bulk-import will be uploaded and not the status of the previous bulk-imports.

Required properties

  • status_uri.path - URI to which the status needs to be uploaded.

Optional properties

  • status_uri.username - Username of the specified URI.

  • status_uri.password - Password of the specified URI.

  • vserver cifs users-and-groups import get-status

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: 0

  • Max value: 120

  • Min value: 0

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

  • Introduced in: 9.13

Request Body

Name Type Description

status_uri

status_uri

svm

svm
Example request 
{
  "status_uri": {
    "password": "string",
    "path": "http://web.sample.com/web1/file1.7z",
    "username": "user1"
  },
  "svm": {
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

Response

Status: 202, Accepted
Name Type Description

job

job_link
Example response 
{
  "job": {
    "uuid": "string"
  }
}

Error

Status: Default, Error

Definitions

See Definitions

href

Name Type Description

href

string

_links

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

Name Type Description

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

local_cifs_users_and_groups_import

Name Type Description

status_uri

status_uri

svm

svm
Name Type Description

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

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.