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

Retrieve FC ports

Contributors
PDFs

GET /network/fc/ports

Introduced In: 9.6

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 Requesting specific fields to learn more.

  • fabric.name

  • statistics.*

  • metric.*

  • network fcp adapter show

Learn more

Parameters

Name Type In Required Description

metric.timestamp

string

query

False

Filter by metric.timestamp

  • Introduced in: 9.8

metric.status

string

query

False

Filter by metric.status

  • Introduced in: 9.8

metric.throughput.total

integer

query

False

Filter by metric.throughput.total

  • Introduced in: 9.8

metric.throughput.read

integer

query

False

Filter by metric.throughput.read

  • Introduced in: 9.8

metric.throughput.write

integer

query

False

Filter by metric.throughput.write

  • Introduced in: 9.8

metric.duration

string

query

False

Filter by metric.duration

  • Introduced in: 9.8

metric.latency.total

integer

query

False

Filter by metric.latency.total

  • Introduced in: 9.8

metric.latency.other

integer

query

False

Filter by metric.latency.other

  • Introduced in: 9.8

metric.latency.read

integer

query

False

Filter by metric.latency.read

  • Introduced in: 9.8

metric.latency.write

integer

query

False

Filter by metric.latency.write

  • Introduced in: 9.8

metric.iops.total

integer

query

False

Filter by metric.iops.total

  • Introduced in: 9.8

metric.iops.other

integer

query

False

Filter by metric.iops.other

  • Introduced in: 9.8

metric.iops.read

integer

query

False

Filter by metric.iops.read

  • Introduced in: 9.8

metric.iops.write

integer

query

False

Filter by metric.iops.write

  • Introduced in: 9.8

state

string

query

False

Filter by state

fabric.connected

boolean

query

False

Filter by fabric.connected

fabric.switch_port

string

query

False

Filter by fabric.switch_port

fabric.connected_speed

integer

query

False

Filter by fabric.connected_speed

fabric.name

string

query

False

Filter by fabric.name

fabric.port_address

string

query

False

Filter by fabric.port_address

physical_protocol

string

query

False

Filter by physical_protocol

uuid

string

query

False

Filter by uuid

statistics.latency_raw.total

integer

query

False

Filter by statistics.latency_raw.total

  • Introduced in: 9.8

statistics.latency_raw.other

integer

query

False

Filter by statistics.latency_raw.other

  • Introduced in: 9.8

statistics.latency_raw.read

integer

query

False

Filter by statistics.latency_raw.read

  • Introduced in: 9.8

statistics.latency_raw.write

integer

query

False

Filter by statistics.latency_raw.write

  • Introduced in: 9.8

statistics.throughput_raw.total

integer

query

False

Filter by statistics.throughput_raw.total

  • Introduced in: 9.8

statistics.throughput_raw.read

integer

query

False

Filter by statistics.throughput_raw.read

  • Introduced in: 9.8

statistics.throughput_raw.write

integer

query

False

Filter by statistics.throughput_raw.write

  • Introduced in: 9.8

statistics.status

string

query

False

Filter by statistics.status

  • Introduced in: 9.8

statistics.iops_raw.total

integer

query

False

Filter by statistics.iops_raw.total

  • Introduced in: 9.8

statistics.iops_raw.other

integer

query

False

Filter by statistics.iops_raw.other

  • Introduced in: 9.8

statistics.iops_raw.read

integer

query

False

Filter by statistics.iops_raw.read

  • Introduced in: 9.8

statistics.iops_raw.write

integer

query

False

Filter by statistics.iops_raw.write

  • Introduced in: 9.8

statistics.timestamp

string

query

False

Filter by statistics.timestamp

  • Introduced in: 9.8

description

string

query

False

Filter by description

enabled

boolean

query

False

Filter by enabled

supported_protocols

string

query

False

Filter by supported_protocols

name

string

query

False

Filter by name

speed.configured

string

query

False

Filter by speed.configured

speed.maximum

string

query

False

Filter by speed.maximum

node.name

string

query

False

Filter by node.name

node.uuid

string

query

False

Filter by node.uuid

wwpn

string

query

False

Filter by wwpn

wwnn

string

query

False

Filter by wwnn

transceiver.capabilities

integer

query

False

Filter by transceiver.capabilities

transceiver.part_number

string

query

False

Filter by transceiver.part_number

transceiver.manufacturer

string

query

False

Filter by transceiver.manufacturer

transceiver.form_factor

string

query

False

Filter by transceiver.form_factor

  • Introduced in: 9.8

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.

  • Default value: 1

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.

  • Default value: 1

  • Max value: 120

  • Min value: 0

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"
      },
      "metric": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "duration": "PT15S",
        "iops": {
          "read": "200",
          "total": "1000",
          "write": "100"
        },
        "latency": {
          "read": "200",
          "total": "1000",
          "write": "100"
        },
        "status": "ok",
        "throughput": {
          "read": "200",
          "total": "1000",
          "write": "100"
        },
        "timestamp": "2017-01-25T11:20:13Z"
      },
      "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",
      "statistics": {
        "iops_raw": {
          "read": "200",
          "total": "1000",
          "write": "100"
        },
        "latency_raw": {
          "read": "200",
          "total": "1000",
          "write": "100"
        },
        "status": "ok",
        "throughput_raw": {
          "read": "200",
          "total": "1000",
          "write": "100"
        },
        "timestamp": "2017-01-25T11:20:13Z"
      },
      "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 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.

iops

The rate of I/O operations observed at the storage object.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

latency

The round trip latency in microseconds observed at the storage object.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

throughput

The rate of throughput bytes per second observed at the storage object.

Name Type Description

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

metric

Performance numbers, such as IOPS latency and throughput

Name Type Description

_links

_links

duration

string

The duration over which this sample is calculated. The time durations are represented in the ISO-8601 standard format. Samples can be calculated over the following durations:

iops

iops

The rate of I/O operations observed at the storage object.

latency

latency

The round trip latency in microseconds observed at the storage object.

status

string

Any errors associated with the sample. For example, if the aggregation of data over multiple nodes fails then any of the partial errors might be returned, "ok" on success, or "error" on any internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "Inconsistent_ delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "Inconsistent_old_data" is returned when one or more nodes do not have the latest data.

throughput

throughput

The rate of throughput bytes per second observed at the storage object.

timestamp

string

The timestamp of the performance data.

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.

iops_raw

The number of I/O operations observed at the storage object. This should be used along with delta time to calculate the rate of I/O operations per unit of time.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

latency_raw

The raw latency in microseconds observed at the storage object. This should be divided by the raw IOPS value to calculate the average latency per I/O operation.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

throughput_raw

Throughput bytes observed at the storage object. This should be used along with delta time to calculate the rate of throughput bytes per unit of time.

Name Type Description

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

statistics

These are raw performance numbers, such as IOPS latency and throughput. These numbers are aggregated across all nodes in the cluster and increase with the uptime of the cluster.

Name Type Description

iops_raw

iops_raw

The number of I/O operations observed at the storage object. This should be used along with delta time to calculate the rate of I/O operations per unit of time.

latency_raw

latency_raw

The raw latency in microseconds observed at the storage object. This should be divided by the raw IOPS value to calculate the average latency per I/O operation.

status

string

Any errors associated with the sample. For example, if the aggregation of data over multiple nodes fails then any of the partial errors might be returned, "ok" on success, or "error" on any internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "Inconsistent_delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "Inconsistent_old_data" is returned when one or more nodes do not have the latest data.

throughput_raw

throughput_raw

Throughput bytes observed at the storage object. This should be used along with delta time to calculate the rate of throughput bytes per unit of time.

timestamp

string

The timestamp of the performance data.

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

  • unknown - 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.

metric

metric

Performance numbers, such as IOPS latency and throughput

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.

statistics

statistics

These are raw performance numbers, such as IOPS latency and throughput. These numbers are aggregated across all nodes in the cluster and increase with the uptime of the cluster.

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.