fcp

Contributors

fcp-adapter-config-down

PATCH /api/network/fc/ports/{uuid}

Note: Set property "enabled" to "false".

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

fcp-adapter

name

Available for GET in the REST API endpoint. For PATCH, specify the port’s UUID.

node

node.name

Available for GET in the REST API endpoint. For PATCH, specify the port’s UUID.

fcp-adapter-config-up

PATCH /api/network/fc/ports/{uuid}

Note: Set property "enabled" to "true".

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

fcp-adapter

name

Available for GET in the REST API endpoint. For PATCH, specify the port’s UUID.

node

node.name

Available for GET in the REST API endpoint. For PATCH, specify the port’s UUID.

fcp-adapter-dump

This ONTAPI call does not have an equivalent REST API call.

fcp-adapter-get-iter

GET /api/network/fc/ports

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

adapter

name

connection-established

No REST Equivalent

data-link-rate

fabric.connected_speed

data-protocols-supported

supported_protocols

fabric-established

fabric.connected

fabric-name

fabric.name

firmware-rev

No REST Equivalent

hardware-rev

No REST Equivalent

info-name

description

is-sfp-diagnostics-internally-calibrated

No REST Equivalent

is-sfp-optical-transceiver-valid

No REST Equivalent

is-sfp-rx-in-los

No REST Equivalent

is-sfp-rx-power-in-range

No REST Equivalent

is-sfp-tx-in-disable

No REST Equivalent

is-sfp-tx-in-fault

No REST Equivalent

is-sfp-tx-power-in-range

No REST Equivalent

max-speed

speed.maximum

media-type

No REST Equivalent

This attribute is obsolete. It is always "p2p" in ONTAP.

node

node.name

node-name

wwnn

physical-protocol

physical_protocol

port-address

fabric.port_address

port-name

wwpn

sfp-connector

No REST Equivalent

sfp-date-code

No REST Equivalent

sfp-ddm-capabilities

No REST Equivalent

sfp-ddm-status-control

No REST Equivalent

sfp-diagnostic-monitoring-type

No REST Equivalent

sfp-encoding

No REST Equivalent

sfp-fc-speedcapabilities

transceiver.capabilities

sfp-formfactor

transceiver.form_factor

sfp-part-number

transceiver.part_number

sfp-rev

No REST Equivalent

sfp-rx-power

No REST Equivalent

sfp-serial-number

No REST Equivalent

sfp-sff8472-compliance

No REST Equivalent

sfp-tx-power

No REST Equivalent

sfp-vendor-name

transceiver.manufacturer

sfp-vendor-oui

No REST Equivalent

sfp-wavelength

No REST Equivalent

speed

speed.configured

state

enabled

status-admin

enabled

status-extended

No REST Equivalent

switch-port

fabric.switch_port

max-records

max_records

Specifies the maximum number of records to return before paging.

fcp-adapter-reset

This ONTAPI call does not have an equivalent REST API call.

fcp-adapter-set-speed

This ONTAPI call does not have an equivalent REST API call.

fcp-adapter-stats-get-iter

GET /api/network/fc/ports

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

adapter

name

adapter-resets

No REST Equivalent

crc-errors

No REST Equivalent

discarded-frames

No REST Equivalent

frame-overruns

No REST Equivalent

frame-underruns

No REST Equivalent

initiators-connected

No REST Equivalent

invalid-xmit-words

No REST Equivalent

is-sfp-diagnostics-internally-calibrated

No REST Equivalent

is-sfp-optical-transceiver-valid

No REST Equivalent

is-sfp-rx-power-in-range

No REST Equivalent

is-sfp-tx-power-in-range

No REST Equivalent

link-breaks

No REST Equivalent

lip-resets

No REST Equivalent

lr-received

No REST Equivalent

lr-sent

No REST Equivalent

node

node.name

nos-received

No REST Equivalent

ols-received

No REST Equivalent

protocol-errors

No REST Equivalent

queue-depth

No REST Equivalent

scsi-requests-dropped

No REST Equivalent

sfp-connector

No REST Equivalent

sfp-date-code

No REST Equivalent

sfp-encoding

No REST Equivalent

sfp-fc-speedcapabilities

transceiver.capabilities

sfp-formfactor

transceiver.form_factor

sfp-part-number

transceiver.part_number

sfp-rev

No REST Equivalent

sfp-rx-power

No REST Equivalent

sfp-serial-number

No REST Equivalent

sfp-tx-power

No REST Equivalent

sfp-vendor-name

transceiver.manufacturer

sfp-vendor-oui

No REST Equivalent

sfp-wavelength

No REST Equivalent

spurious-interrupts

No REST Equivalent

total-logins

No REST Equivalent

total-logouts

No REST Equivalent

max-records

max_records

Specifies the maximum number of records to return before paging.

fcp-initiator-get-iter

GET /api/network/fc/logins

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

adapter

interface.name

data-protocol

protocol

fcp-connected-initiators

initiator

This is an object containing several properties of the logged in initiator.

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

fcp-interface-get-iter

GET /api/network/fc/interfaces

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

current-node

location.node.name

current-port

location.port.name

interface-name

name

node-name

wwnn

port-address

port_address

port-name

wwpn

relative-port-id

No REST Equivalent

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

fcp-nameserver-get-iter

This ONTAPI call does not have an equivalent REST API call.

fcp-node-get-name

GET /api/protocols/san/fcp/services

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

There are no attributes defined for this ONTAPI call.

fcp-node-set-name

This ONTAPI call does not have an equivalent REST API call.

fcp-ping-igroup-view-get-iter

This ONTAPI call does not have an equivalent REST API call.

fcp-ping-initiator-get-iter

This ONTAPI call does not have an equivalent REST API call.

fcp-port-name-get-iter

GET /api/network/fc/interfaces

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

fcp-adapter

name

is-used

No REST Equivalent

This property is obsolete. It is always "true" in ONTAP.

port-name

wwpn

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

fcp-port-name-set

This ONTAPI call does not have an equivalent REST API call.

fcp-service-create

POST /api/protocols/san/fcp/services

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

force-node-name

No REST Equivalent

node-name

No REST Equivalent

start

enabled

fcp-service-destroy

DELETE /api/protocols/san/fcp/services/{svm.uuid}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

There are no attributes defined for this ONTAPI call.

fcp-service-get-iter

GET /api/protocols/san/fcp/services

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

is-available

enabled

node-name

target.name

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

fcp-service-start

PATCH /api/protocols/san/fcp/services/{svm.uuid}

Note: In the REST API, PATCH the enabled property to "true".

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

There are no attributes defined for this ONTAPI call.

fcp-service-status

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

Note: In the REST API, GET the value of the enabled property.

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

There are no attributes defined for this ONTAPI call.

fcp-service-stop

PATCH /api/protocols/san/fcp/services/{svm.uuid}

Note: In the REST API, PATCH the enabled property to "false".

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

There are no attributes defined for this ONTAPI call.

fcp-topology-get-iter

This ONTAPI call does not have an equivalent REST API call.

fcp-topology-port-get-iter

GET /api/network/fc/fabrics

Note: FC fabric information is obtained using the REST endpoints under
/api/network/fc/fabrics. High-level fabric information is obtained
using GET /api/network/fc/fabrics. Switch information is obtained using
GET /api/network/fc/fabrics/{fabric.name}/switches.

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

adapter

connections.cluster_port.name

Obtained using GET /api/network/fc/fabrics?fields=connections

domain-id

domain_id

Obtained using GET /api/network/fc/fabrics/{fabric.name}/switches

node

connections.cluster_port.node.name

Obtained using GET /api/network/fc/fabrics?fields=connections

port-attached-id

No REST Equivalent

port-attached-visible

No REST Equivalent

port-attached-wwpn

ports.attached_device.wwpn

Obtained using GET /api/network/fc/fabrics/{fabric.name}/switches?fields=ports

port-count

No REST Equivalent

port-slot

ports.slot

Obtained using GET /api/network/fc/fabrics/{fabric.name}/switches?fields=ports

port-state

ports.state

Obtained using GET /api/network/fc/fabrics/{fabric.name}/switches?fields=ports

port-type

ports.type

Obtained using GET /api/network/fc/fabrics/{fabric.name}/switches?fields=ports

port-wwpn

ports.wwpn

Obtained using GET /api/network/fc/fabrics/{fabric.name}/switches?fields=ports

switch-name

name

Obtained using GET /api/network/fc/fabrics/{fabric.name}/switches

switch-release

release

Obtained using GET /api/network/fc/fabrics/{fabric.name}/switches

switch-vendor

vendor

Obtained using GET /api/network/fc/fabrics/{fabric.name}/switches

switch-wwn

wwn

Obtained using GET /api/network/fc/fabrics/{fabric.name}/switches

max-records

max_records

Specifies the maximum number of records to return before paging.

fcp-wwpnalias-get-iter

GET /api/network/fc/wwpn-aliases

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

aliases-alias

alias

aliases-wwpn

wwpn

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

fcp-wwpnalias-remove

DELETE /api/network/fc/wwpn-aliases/{svm.uuid}/{alias}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

alias

alias

wwpn

wwpn

To delete all aliases for a WWPN value, first query the aliases by using a GET call, and then delete each alias.

fcp-wwpnalias-set

POST /api/network/fc/wwpn-aliases

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

alias

alias

force

No REST Equivalent

wwpn

wwpn

fcp-zone-get-iter

GET /api/network/fc/fabrics/{fabric.name}/zones

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

adapter

No REST Equivalent

contents

members.name

domain-id

members.name

node

No REST Equivalent

port

No REST Equivalent

port-id

No REST Equivalent

type

members.type

type-name

members.type

unique

No REST Equivalent

wwn

members.name

zone-count

No REST Equivalent

zone-member-count

No REST Equivalent

zone-name

name

zoneset-name

zoneset.name

Obtained using GET /api/network/fc/fabrics?fields=zoneset

max-records

max_records

Specifies the maximum number of records to return before paging.