Skip to main content

Retrieve FC fabric switches

Contributors
PDFs

GET /network/fc/fabrics/{fabric.name}/switches

Introduced In: 9.11

Retrieves the Fibre Channel switches of a Fibre Channel fabric.

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.

  • ports

  • network fcp topology show

Learn more

Parameters

Name Type In Required Description

fabric.name

string

path

True

The WWN of the primary switch of the Fibre Channel fabric.

vendor

string

query

False

Filter by vendor

release

string

query

False

Filter by release

domain_id

integer

query

False

Filter by domain_id

  • Max value: 239

  • Min value: 1

ports.state

string

query

False

Filter by ports.state

ports.slot

string

query

False

Filter by ports.slot

ports.attached_device.wwpn

string

query

False

Filter by ports.attached_device.wwpn

ports.attached_device.port_id

string

query

False

Filter by ports.attached_device.port_id

ports.type

string

query

False

Filter by ports.type

ports.wwpn

string

query

False

Filter by ports.wwpn

wwn

string

query

False

Filter by wwn

name

string

query

False

Filter by name

cache.is_current

boolean

query

False

Filter by cache.is_current

cache.age

string

query

False

Filter by cache.age

cache.update_time

string

query

False

Filter by cache.update_time

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.

  • Max value: 120

  • Min value: 0

  • Default value: 1

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[fc_switch]
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"
      },
      "domain_id": 1,
      "fabric": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "10:00:d1:d2:d3:d4:d5:d6"
      },
      "name": "switch1",
      "ports": [
        {
          "attached_device": {
            "port_id": 70400,
            "wwpn": "50:0a:21:22:23:24:25:26"
          },
          "slot": 1,
          "state": "online",
          "type": "string",
          "wwpn": "50:0a:31:32:33:34:35:36"
        }
      ],
      "release": "1.0.",
      "vendor": "vendor1",
      "wwn": "10:00:e1:e2:e3:e4:e5:e6"
    }
  ]
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

5373982

An invalid WWN was specified. The length is incorrect.

5373983

An invalid WWN was specified. The format is incorrect.

5375053

The Fibre Channel fabric specified by name in the request URI was not found in the FC fabric cache.

Also see the table of common errors in the Response body overview section of this documentation.

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.

fabric

A reference to a Fibre Channel fabric.

Name Type Description

_links

_links

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.

attached_device

The Fibre Channel (FC) device attached to the FC switch port.

Name Type Description

port_id

string

The Fibre Channel port identifier of the attach device.

wwpn

string

The world-wide port name (WWPN) of the attached device.

ports

A Fibre Channel switch port.

Name Type Description

attached_device

attached_device

The Fibre Channel (FC) device attached to the FC switch port.

slot

string

The slot of the Fibre Channel switch port.

state

string

The state of the Fibre Channel switch port.

type

string

The type of the Fibre Channel switch port.

wwpn

string

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

fc_switch

A Fibre Channel switch.

Name Type Description

_links

_links

cache

cache

Properties of Fibre Chanel fabric cache.

domain_id

integer

The domain identifier (ID) of the Fibre Channel (FC) switch. The domain ID is a unique identifier for the FC switch in the FC fabric.

fabric

fabric

A reference to a Fibre Channel fabric.

name

string

The logical name of the Fibre Channel switch.

ports

array[ports]

An array of the Fibre Channel (FC) switch's ports and their attached FC devices.

release

string

The firmware release of the Fibre Channel switch.

vendor

string

The vendor of the Fibre Channel switch.

wwn

string

The world-wide name (WWN) for the Fibre Channel switch.

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.