Skip to main content

Retrieve import operation status for CIFS local users, groups, and group memberships

Contributors
PDFs

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

Introduced In: 9.11

Retrieves information about the import operation status of the CIFS local users, groups, and group memberships.

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

Parameters

Name Type In Required Description

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
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 response 
{
  "_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"
  }
}

Error

Status: Default, Error
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.

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.