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

Retrieves the netgroup file details for a given svm if the header is set as "accept: application/json"

  • for a raw netgroup file, set the header as "accept: multipart/form-data" else "accept: application/json" for netgroup file details

  • maximum size supported for raw netgroup file is 5mb, but netgroup file details of any valid svm can be retrived if present # related ontap commands

  • vserver services name-service netgroup status

  • vserver services name-service netgroup file show # learn more

  • [doc /name-services/netgroup-files/{svmuuid}](#docs-name-services-name-services_netgroup-files_{svmuuid})

GET /name-services/netgroup-files/{svm.uuid}

Introduced In: 9.11

Retrieves the netgroup file details for a given SVM if the header is set as "accept: application/json". If the header is set as "accept: multipart/form-data", the raw netgroup file of the given SVM is retrieved.

Important notes

  • For a raw netgroup file, set the header as "accept: multipart/form-data" else "accept: application/json" for netgroup file details.

  • Maximum size supported for raw netgroup file is 5MB, but netgroup file details of any valid SVM can be retrived if present.

  • vserver services name-service netgroup status

  • vserver services name-service netgroup file show

Parameters

Name Type In Required Description

fields

array[string]

query

False

Specify the fields to return.

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

Response

Status: 200, Ok
Name Type Description

_links

_links

file_size

integer

File size of the netgroup definitions file in bytes.

hash_value

string

Hash value of the netgroup definitions.

hash_value_by_host

string

Hash value of the netgroup-by-host database.

svm

svm

timestamp

string

Load time for netgroup definitions.

Example response
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "file_size": 5118686,
  "hash_value": "e53ec87782356bd6786f146ce0a48449",
  "hash_value_by_host": "e012b7f62e4810936725ed1239018314",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "timestamp": "string"
}

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

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.

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.

Close
Try it out

Sign in with your NetApp Cloud Central credentials.

Try this API

Parameters

Headers

Body

Code

Response