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

Retrieve FC fabric zones

Contributors
PDFs

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

Introduced In: 9.11

Retrieves the zones of the active zoneset of a Fibre Channel fabric.

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.

  • members

  • network fcp zone show

Learn more

Parameters

Name Type In Required Description

members.type

string

query

False

Filter by members.type

members.name

string

query

False

Filter by members.name

cache.is_current

boolean

query

False

Filter by cache.is_current

cache.update_time

string

query

False

Filter by cache.update_time

cache.age

string

query

False

Filter by cache.age

name

string

query

False

Filter by 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[fc_zone]
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"
    },
    "fabric": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "10:00:d1:d2:d3:d4:d5:d6"
    },
    "members": {
      "name": "10:00:12:34:56:78:9a:bc",
      "type": "port_name"
    },
    "name": "zone1"
  }
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

5375053

The Fibre Channel fabric specified by name in the request URI was not found in the FC fabric cache.
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

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.

members

A Fibre Channel zone member.

Name Type Description

name

string

The identifying property value of the zone member. The format of this value depends on the member type:

  • port_id: A zero-filled 6-digit hexadecimal value with a 0x prefer. Example: 0x0000A0.

  • port_name: A world-wide name. Example: 10:00:12:34:56:78:9a:bc.

  • domain_id_port: A domain ID and a port ID as decimal integers separated by a slash. Example: 1/2.

  • node_name: A world-wide name. Example: 10:00:11:22:33:44:55:66.

  • fabric_port_name: A world-wide name. Example: 10:00:ab:cd:ef:12:34:56.

#

The following types might not report a name:

  • interface

  • domain_interface

  • ip_address

  • symbolic_node_name

  • device_alias

type

string

The type of Fibre Channel zone member. This value should be used to interpret the contents of the name property.

fc_zone

A Fibre Channel zone.

Name Type Description

_links

_links

cache

cache

Properties of Fibre Chanel fabric cache.

fabric

fabric

A reference to a Fibre Channel fabric.

members

array[members]

An array of Fibre Channel zone members.

name

string

The name of the Fibre Channel zone.

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.