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

Retrieve FC ports

Contributors
PDFs

GET /network/fc/ports

Retrieves FC ports.

Expensive properties

There is an added cost to retrieving values for these properties. They are not included by default in GET results and must be explicitly requested using the fields query parameter. See DOC Requesting specific fields to learn more.

  • fabric.name

  • network fcp adapter show

Learn more

Parameters

Name Type In Required Description

speed.maximum

string

query

False

Filter by speed.maximum

speed.configured

string

query

False

Filter by speed.configured

state

string

query

False

Filter by state

transceiver.manufacturer

string

query

False

Filter by transceiver.manufacturer

transceiver.capabilities

integer

query

False

Filter by transceiver.capabilities

transceiver.form-factor

string

query

False

Filter by transceiver.form-factor

transceiver.part_number

string

query

False

Filter by transceiver.part_number

name

string

query

False

Filter by name

node.uuid

string

query

False

Filter by node.uuid

node.name

string

query

False

Filter by node.name

enabled

boolean

query

False

Filter by enabled

physical_protocol

string

query

False

Filter by physical_protocol

uuid

string

query

False

Filter by uuid

fabric.port_address

string

query

False

Filter by fabric.port_address

fabric.connected_speed

integer

query

False

Filter by fabric.connected_speed

fabric.name

string

query

False

Filter by fabric.name

fabric.switch_port

string

query

False

Filter by fabric.switch_port

fabric.connected

boolean

query

False

Filter by fabric.connected

wwnn

string

query

False

Filter by wwnn

wwpn

string

query

False

Filter by wwpn

description

string

query

False

Filter by description

supported_protocols

string

query

False

Filter by supported_protocols

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records.

records

array[fc_port]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "description": "Fibre Channel Target Adapter 0a (ACME Fibre Channel Adapter, rev. 1.0.0, 8G)",
      "fabric": {
        "connected_speed": 16,
        "name": "string",
        "port_address": "52100A",
        "switch_port": "ssan-g620-03:33"
      },
      "name": "0a",
      "node": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "node1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "physical_protocol": "string",
      "speed": {
        "configured": "auto",
        "maximum": 32
      },
      "state": "online",
      "supported_protocols": [
        "string"
      ],
      "transceiver": {
        "capabilities": [
          16
        ],
        "form-factor": "string",
        "manufacturer": "Acme, Inc.",
        "part_number": "string"
      },
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412",
      "wwnn": "20:00:00:50:56:b4:13:a8",
      "wwpn": "20:00:00:50:56:b4:13:a8"
    }
  ]
}

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

_links

Name Type Description

next

href

self

href

_links

Name Type Description

self

href

fabric

Properties of the fabric to which the FC port is attached.

Name Type Description

connected

boolean

Reports if the physical port has established a connection with the FC fabric.

connected_speed

integer

The negotiated data rate between the target FC port and the fabric in gigabits per second.

name

string

The name of the fabric to which the port is connected. This is only available when the FC port is connected to a fabric.

There is an added cost to retrieving this property's value. It is not populated for either a collection GET or an instance GET unless it is explicitly requested using the fields query parameter. See DOC Requesting specific fields to learn more.

port_address

string

The FC port address of the host bus adapter (HBA) physical port.

Each FC port in an FC switched fabric has its own unique FC port address for routing purposes. The FC port address is assigned by a switch in the fabric when that port logs in to the fabric. This property refers to the FC port address given to the physical host bus adapter (HBA) port when the port performs a fabric login (FLOGI).

This is useful for obtaining statistics and diagnostic information from FC switches.

This is a six-digit hexadecimal encoded numeric value.

switch_port

string

The switch port to which the FC port is connected.

node

Name Type Description

_links

_links

name

string

uuid

string

speed

The physical device speed related properties of the FC port.

Name Type Description

configured

string

The configured speed of the FC port in gigabits per second.

maximum

string

The maximum speed supported by the FC port in gigabits per second.

transceiver

Properties of the transceiver connected to the FC port.

Name Type Description

capabilities

array[integer]

The speeds of which the transceiver is capable in gigabits per second.

form-factor

string

The form factor of the transceiver. Possible values are:

  • sfp - Small Form Factor - Pluggable

  • sff - Small Form Factor

  • unk - Unknown

manufacturer

string

The manufacturer of the transceiver.

part_number

string

The part number of the transceiver.

fc_port

A Fibre Channel (FC) port is the physical port of an FC adapter on an ONTAP cluster node that can be connected to an FC network to provide FC network connectivity. An FC port defines the location of an FC interface within the ONTAP cluster.

Name Type Description

_links

_links

description

string

A description of the FC port.

enabled

boolean

The administrative state of the FC port. If this property is set to false, all FC connectivity to FC interfaces are blocked. Optional in PATCH.

fabric

fabric

Properties of the fabric to which the FC port is attached.

name

string

The FC port name.

node

node

physical_protocol

string

The physical network protocol of the FC port.

speed

speed

The physical device speed related properties of the FC port.

state

string

The operational state of the FC port.

  • startup - The port is booting up.

  • link_not_connected - The port has finished initialization, but a link with the fabric is not established.

  • online - The port is initialized and a link with the fabric has been established.

  • link_disconnected - The link was present at one point on this port but is currently not established.

  • offlined_by_user - The port is administratively disabled.

  • offlined_by_system - The port is set to offline by the system. This happens when the port encounters too many errors.

  • node_offline - The state information for the port cannot be retrieved. The node is offline or inaccessible.

supported_protocols

array[string]

The network protocols supported by the FC port.

transceiver

transceiver

Properties of the transceiver connected to the FC port.

uuid

string

The unique identifier of the FC port.

wwnn

string

The base world wide node name (WWNN) for the FC port.

wwpn

string

The base world wide port name (WWPN) for the FC port.

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.