Skip to main content

Retrieve FC fabrics

Contributors
PDFs

GET /network/fc/fabrics

Introduced In: 9.11

Retrieves Fibre Channel fabrics.

Expensive properties

There is an added computational 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.

  • connections

  • zoneset

  • network fcp topology show

  • network fcp zone show

Learn more

Parameters

Name Type In Required Description

name

string

query

False

Filter by name

connections.switch.wwn

string

query

False

Filter by connections.switch.wwn

connections.switch.port.wwpn

string

query

False

Filter by connections.switch.port.wwpn

connections.cluster_port.uuid

string

query

False

Filter by connections.cluster_port.uuid

connections.cluster_port.node.name

string

query

False

Filter by connections.cluster_port.node.name

connections.cluster_port.name

string

query

False

Filter by connections.cluster_port.name

connections.cluster_port.wwpn

string

query

False

Filter by connections.cluster_port.wwpn

cache.age

string

query

False

Filter by cache.age

cache.is_current

boolean

query

False

Filter by cache.is_current

cache.update_time

string

query

False

Filter by cache.update_time

zoneset.name

string

query

False

Filter by zoneset.name

cache.maximum_age

string

query

False

The maximum age of data in the Fibre Channel fabric cache before it should be refreshed from the fabric. The default is 15 minutes.

  • Default value: 1

  • format: iso8601

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

The number of records in the response.

records

array[fabric]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "cache": {
        "age": "PT3M30S",
        "update_time": "string"
      },
      "connections": [
        {
          "cluster_port": {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "name": "0a",
            "node": {
              "name": "node1"
            },
            "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412",
            "wwpn": "50:0a:11:22:33:44:55:66"
          },
          "switch": {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "port": {
              "wwpn": "50:0a:a1:a2:a3:a4:a5:a6"
            },
            "wwn": "10:00:b1:b2:b3:b4:b4:b6"
          }
        }
      ],
      "name": "10:00:c1:c2:c3:c4:c5:c6",
      "zoneset": {
        "name": "zoneset1"
      }
    }
  ]
}

Error

Status: Default, Error
Name Type Description

error

returned_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

cache

Properties of Fibre Chanel fabric cache.

Name Type Description

age

string

The age of the Fibre Channel fabric data cache retrieved. If the FC fabric data cache has not been fully updated for a newly discovered fabric, or a fabric that has been re-discovered after being purged, a value for this property will not be retrieved. The value is in ISO 8601 duration format.

is_current

boolean

A boolean that indicates if the retrieved data is current relative to the cache.maximum_age value of the request. A value of true indicates that the data is no older than the requested maximum age. A value of false indicates that the data is older than the requested maximum age; if more current data is required, the caller should wait for some time for the cache update to complete and query the data again.

update_time

string

The date and time at which the Fibre Channel fabric data cache retrieved was last updated. If the FC fabric data cache has not been fully updated for a newly discovered fabric, or a fabric that has been re-discovered after being purged, a value for this property will not be retrieved.

node

The node on which the cluster Fibre Channel port is located.

Name Type Description

name

string

The name of the node on which the cluster Fibre Channel port is located.

cluster_port

The cluster Fibre Channel (FC) port that connects the FC fabric.

Name Type Description

_links

_links

name

string

The name of the cluster Fibre Channel port.

node

node

The node on which the cluster Fibre Channel port is located.

uuid

string

The unique identifier of the cluster Fibre Channel port.

wwpn

string

The world wide port name (WWPN) of the cluster Fibre Channel port.

port

The port of the Fibre Channel switch to which the cluster node port is connected.

Name Type Description

wwpn

string

The world wide port name (WWPN) of the Fibre Channel switch port.

switch

The Fibre Channel switch to which the cluster node port is connected.

Name Type Description

_links

_links

port

port

The port of the Fibre Channel switch to which the cluster node port is connected.

wwn

string

The world-wide name (WWN) of the Fibre Channel switch to which the cluster node port is attached.

connections

A connection between a cluster node Fibre Channel (FC) port and an FC switch port.

Name Type Description

cluster_port

cluster_port

The cluster Fibre Channel (FC) port that connects the FC fabric.

switch

switch

The Fibre Channel switch to which the cluster node port is connected.

zoneset

The active Fibre Channel zoneset in the fabric.

Name Type Description

name

string

The name of the Fibre Channel zoneset.

fabric

A Fibre Channel (FC) fabric REST object provides information about an FC network (fabric) connected to the cluster. Logically, the FC fabric also contains FC switches and the FC zones that comprise the active zoneset of the fabric. FC switch and zone information is not reported directly in the FC fabric REST object for reasons of scale and flexibility; they are found by querying the FC switches and FC zones REST endpoints.

Name Type Description

_links

_links

cache

cache

Properties of Fibre Chanel fabric cache.

connections

array[connections]

An array of the connections between the cluster and the switches Fibre Channel fabric.

name

string

The world wide name (WWN) of the primary switch of the Fibre Channel (FC) fabric. This is used as a unique identifier for the FC fabric.

zoneset

zoneset

The active Fibre Channel zoneset in the fabric.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_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.