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

Create an FC interface

Contributors

POST /network/fc/interfaces

Creates an FC interface.

Required properties

  • svm.uuid or svm.name - Existing SVM in which to create the FC interface.

  • name - Name of the FC interface.

  • location.port.uuid or both location.port.name and location.port.node.name - FC port on which to create the FC interface.

  • data_protocol - Data protocol for the FC interface.

Default property values

If not specified in POST, the following default property values are assigned.

  • enabled - true

  • network interface create

Parameters

Name Type In Required Description

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

Request Body

Name Type Description

_links

_links

comment

string

A user configurable comment. Optional in POST; valid in PATCH. To clear a prior comment, set the property to an empty string in PATCH.

data_protocol

string

The data protocol for which the FC interface is configured. Required in POST.

enabled

boolean

The administrative state of the FC interface. The FC interface can be disabled to block all FC communication with the SVM through this interface. Optional in POST and PATCH; defaults to true (enabled) in POST.

location

location

The location of the FC interface is defined by the location of its port. An FC port is identified by its UUID, or a combination of its node name and port name. Either the UUID or the node name and port name are required for POST. To move an interface, supply either the UUID or the node name and port name in a PATCH.

name

string

The name of the FC interface. Required in POST; optional in PATCH.

port_address

string

The port address of the FC interface. 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 address given by a switch to the FC interface when the SVM performs a port login (PLOGI).

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

This is a hexadecimal encoded numeric value.

state

string

The current operational state of the FC interface. The state is set to down if the interface is not enabled.

If the node hosting the port is down or unavailable, no state value is returned.

svm

svm

uuid

string

The unique identifier of the FC interface. Required in the URL.

wwnn

string

The world wide node name (WWNN) of the FC interface SVM. The WWNN is generated by ONTAP when Fibre Channel Protocol or the NVMe service is created for the FC interface SVM.

  • example: 20:00:00:50:56:b4:13:01

  • readOnly: 1

wwpn

string

The world wide port name (WWPN) of the FC interface. The WWPN is generated by ONTAP when the FC interface is created.

  • example: 20:00:00:50:56:b4:13:a8

  • readOnly: 1

Example request
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "comment": "string",
  "data_protocol": "string",
  "location": {
    "node": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "node1",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    },
    "port": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "0a",
      "node": {
        "name": "node1"
      },
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    }
  },
  "name": "lif1",
  "port_address": "5060F",
  "state": "string",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412",
  "wwnn": "20:00:00:50:56:b4:13:01",
  "wwpn": "20:00:00:50:56:b4:13:a8"
}

Response

Status: 201, Created
Name Type Description

_links

_links

num_records

integer

Number of records.

records

array[fc_interface]

Example response
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "comment": "string",
      "data_protocol": "string",
      "location": {
        "node": {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "name": "node1",
          "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
        },
        "port": {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "name": "0a",
          "node": {
            "name": "node1"
          },
          "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
        }
      },
      "name": "lif1",
      "port_address": "5060F",
      "state": "string",
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412",
      "wwnn": "20:00:00:50:56:b4:13:01",
      "wwpn": "20:00:00:50:56:b4:13:a8"
    }
  ]
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

1966140

An interface with the same name already exists.

1966217

The specified port is not valid on the node provided.

2621462

The supplied SVM does not exist.

2621706

The specified svm.uuid and svm.name do not refer to the same SVM.

2621707

No SVM was specified. Either svm.name or svm.uuid must be supplied.

5373966

A Fibre Channel interface with the fcp protocol cannot be created in an SVM that is configured for NVMe.

5374102

The specified Fibre Channel interface cannot be created because the Fibre Channel adapter is down. Bring the adapter up and try again.

5374871

The Fibre Channel port identified by the specified UUID does not refer to the same port as that identified by the specified node name and/or port name.

5374872

If either location.port.node.name or location.port.name is supplied, both properties must be supplied.

5374873

The Fibre Channel port must be specified using either location.port.uuid or location.port.node.name and location.port.name.

72089652

An NVMe service must be created before creating a Fibre Channel interface using the NVMe over FC data protocol.

72089672

The specified Fibre Channel port does not support the NVMe over FC data protocol.

72089900

A Fibre Channel interface with the fc_nvme protocol cannot be created in an SVM that is configured for a SAN protocol.

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

Name Type Description

self

href

node

Name Type Description

_links

_links

name

string

uuid

string

node

The node on which the FC port is located.

Name Type Description

name

string

The name of the node on which the FC port is located.

fc_port_reference

An FC port is the physical port of an FC adapter on a cluster node that can be connected to an FC network.

Name Type Description

_links

_links

name

string

The name of the FC port.

node

node

The node on which the FC port is located.

uuid

string

The unique identifier of the FC port.

location

The location of the FC interface is defined by the location of its port. An FC port is identified by its UUID, or a combination of its node name and port name. Either the UUID or the node name and port name are required for POST. To move an interface, supply either the UUID or the node name and port name in a PATCH.

Name Type Description

node

node

port

fc_port_reference

An FC port is the physical port of an FC adapter on a cluster node that can be connected to an FC network.

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

fc_interface

A Fibre Channel (FC) interface is the logical endpoint for FC network connections to an SVM. An FC interface provides FC access to storage within the interface SVM using either Fibre Channel Protocol or NVMe over Fibre Channel (NVMe/FC).

An FC interface is created on an FC port which is located on a cluster node. The FC port must be specified to identify the location of the interface for a POST or PATCH operation that relocates an interface. You can identify the port by supplying either the node and port names or the port UUID.

Name Type Description

_links

_links

comment

string

A user configurable comment. Optional in POST; valid in PATCH. To clear a prior comment, set the property to an empty string in PATCH.

data_protocol

string

The data protocol for which the FC interface is configured. Required in POST.

enabled

boolean

The administrative state of the FC interface. The FC interface can be disabled to block all FC communication with the SVM through this interface. Optional in POST and PATCH; defaults to true (enabled) in POST.

location

location

The location of the FC interface is defined by the location of its port. An FC port is identified by its UUID, or a combination of its node name and port name. Either the UUID or the node name and port name are required for POST. To move an interface, supply either the UUID or the node name and port name in a PATCH.

name

string

The name of the FC interface. Required in POST; optional in PATCH.

port_address

string

The port address of the FC interface. 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 address given by a switch to the FC interface when the SVM performs a port login (PLOGI).

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

This is a hexadecimal encoded numeric value.

state

string

The current operational state of the FC interface. The state is set to down if the interface is not enabled.

If the node hosting the port is down or unavailable, no state value is returned.

svm

svm

uuid

string

The unique identifier of the FC interface. Required in the URL.

wwnn

string

The world wide node name (WWNN) of the FC interface SVM. The WWNN is generated by ONTAP when Fibre Channel Protocol or the NVMe service is created for the FC interface SVM.

  • example: 20:00:00:50:56:b4:13:01

  • readOnly: 1

wwpn

string

The world wide port name (WWPN) of the FC interface. The WWPN is generated by ONTAP when the FC interface is created.

  • example: 20:00:00:50:56:b4:13:a8

  • readOnly: 1

Name Type Description

next

href

self

href

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.