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

Retrieve an FC protocol service

PDFs

GET /protocols/san/fcp/services/{svm.uuid}

Retrieves a Fibre Channel Protocol service.

  • vserver fcp show

Learn more

Parameters

Name Type In Required Description

svm.uuid

string

path

True

The unique identifier of the SVM for which to retrieve the FC Protocol service.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

enabled

boolean

The administrative state of the FC Protocol service. The FC Protocol service can be disabled to block all FC Protocol connectivity to the SVM.

This is optional in POST and PATCH. The default setting is true (enabled) in POST.

svm

svm

SVM, applies only to SVM-scoped objects.

target

target
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "target": {
    "name": "20:00:00:50:56:bb:b2:4b"
  }
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

2621462

An SVM with the specified UUID does not exist.

5374083

There is no Fibre Channel Protocol service for the specified SVM.
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

SVM, applies only to SVM-scoped objects.

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

target

Name Type Description

name

string

The target name of the FC Protocol service. This is generated for the SVM during POST.

The FC Protocol target name is a world wide node name (WWNN).

If required, the target name can be modified using the ONTAP command line.

  • example: 20:00:00:50:56:bb:b2:4b

  • maxLength: 128

  • minLength: 1

  • readOnly: 1

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.