Skip to main content

Network FC logins endpoint overview

Contributors
PDFs

Overview

Fibre Channel (FC) logins represent connections formed by FC initiators that have successfully logged in to ONTAP. This represents the FC login on which higher-level protocols such as Fibre Channel Protocol and NVMe over FC (NVMe/FC) rely.

The Fibre Channel logins REST API provides information about active FC logins.

Examples

Retrieving all FC logins

# The API:
GET /api/network/fc/logins

# The call:
curl -X GET "https://<mgmt-ip>/api/network/fc/logins" -H "Accept: application/hal+json"

# The response:
{
"records": [
  {
    "svm": {
      "uuid": "056403da-83a7-4b13-bc78-6a93e8ea3596",
      "name": "svm1",
      "_links": {
        "self": {
          "href": "/api/svm/svms/056403da-83a7-4b13-bc78-6a93e8ea3596"
        }
      }
    },
    "interface": {
      "uuid": "01056403-1383-bc4b-786a-93e8ea35969d",
      "name": "lif1",
      "_links": {
        "self": {
          "href": "/api/network/fc/interfaces/01056403-1383-bc4b-786a-93e8ea35969d"
        }
      }
    },
    "initiator": {
      "wwpn": "8b:21:2f:07:00:00:00:00"
    },
    "_links": {
      "self": {
        "href": "/api/network/fc/logins/01056403-1383-bc4b-786a-93e8ea35969d/8b%3A21%3A2f%3A07%3A00%3A00%3A00%3A00"
      }
    }
  },
  {
    "svm": {
      "uuid": "056403da-83a7-4b13-bc78-6a93e8ea3596",
      "name": "svm1",
      "_links": {
        "self": {
          "href": "/api/svm/svms/056403da-83a7-4b13-bc78-6a93e8ea3596"
        }
      }
    },
    "interface": {
      "uuid": "02056403-1383-bc4b-786a-93e8ea35969d",
      "name": "lif2",
      "_links": {
        "self": {
          "href": "/api/network/fc/interfaces/02056403-1383-bc4b-786a-93e8ea35969d"
        }
      }
    },
    "initiator": {
      "wwpn": "8c:21:2f:07:00:00:00:00"
    },
    "_links": {
      "self": {
        "href": "/api/network/fc/logins/02056403-1383-bc4b-786a-93e8ea35969d/8c%3A21%3A2f%3A07%3A00%3A00%3A00%3A00"
      }
    }
  },
  {
    "svm": {
      "uuid": "156403da-83a7-4b13-bc78-6a93e8ea3596",
      "name": "svm2",
      "_links": {
        "self": {
          "href": "/api/svm/svms/156403da-83a7-4b13-bc78-6a93e8ea3596"
        }
      }
    },
    "interface": {
      "uuid": "03056403-1383-bc4b-786a-93e8ea35969d",
      "name": "lif3",
      "_links": {
        "self": {
          "href": "/api/network/fc/interfaces/00056403-1383-bc4b-786a-93e8ea35969d"
        }
      }
    },
    "initiator": {
      "wwpn": "8a:21:2f:07:00:00:00:00"
    },
    "_links": {
      "self": {
        "href": "/api/network/fc/logins/00056403-1383-bc4b-786a-93e8ea35969d/8a%3A21%3A2f%3A07%3A00%3A00%3A00%3A00"
      }
    }
  }
],
"num_records": 3,
"_links": {
  "self": {
    "href": "/api/network/fc/logins"
  }
}
}

Retrieving all FC logins with data protocol fcp in SVM svm1

The svm.name and protocol query parameters are used to perform the query.

# The API:
GET /api/network/fc/logins

# The call:
curl -X GET "https://<mgmt-ip>/api/network/fc/logins?svm.name=svm1&protocol=fcp" -H "Accept: application/hal+json"

# The response:
{
"records": [
  {
    "svm": {
      "uuid": "056403da-83a7-4b13-bc78-6a93e8ea3596",
      "name": "svm1",
      "_links": {
        "self": {
          "href": "/api/svm/svms/056403da-83a7-4b13-bc78-6a93e8ea3596"
        }
      }
    },
    "interface": {
      "uuid": "01056403-1383-bc4b-786a-93e8ea35969d",
      "name": "lif2",
      "_links": {
        "self": {
          "href": "/api/network/fc/interfaces/01056403-1383-bc4b-786a-93e8ea35969d"
        }
      }
    },
    "initiator": {
      "wwpn": "8b:21:2f:07:00:00:00:00"
    },
    "protocol": "fcp",
    "_links": {
      "self": {
        "href": "/api/network/fc/logins/01056403-1383-bc4b-786a-93e8ea35969d/8b%3A21%3A2f%3A07%3A00%3A00%3A00%3A00"
      }
    }
  },
  {
    "svm": {
      "uuid": "056403da-83a7-4b13-bc78-6a93e8ea3596",
      "name": "svm1",
      "_links": {
        "self": {
          "href": "/api/svm/svms/056403da-83a7-4b13-bc78-6a93e8ea3596"
        }
      }
    },
    "interface": {
      "uuid": "02056403-1383-bc4b-786a-93e8ea35969d",
      "name": "lif3",
      "_links": {
        "self": {
          "href": "/api/network/fc/interfaces/02056403-1383-bc4b-786a-93e8ea35969d"
        }
      }
    },
    "initiator": {
      "wwpn": "8c:21:2f:07:00:00:00:00"
    },
    "protocol": "fcp",
    "_links": {
      "self": {
        "href": "/api/network/fc/logins/02056403-1383-bc4b-786a-93e8ea35969d/8c%3A21%3A2f%3A07%3A00%3A00%3A00%3A00"
      }
    }
  }
],
"num_records": 2,
"_links": {
  "self": {
    "href": "/api/network/fc/logins?svm.name=svm1&protocol=fcp"
  }
}
}

Retrieving all FC logins for initiators belonging to igroup1 and returning all of their properties

The igroups.name query parameter is used to perform the query. The fields query parameter is used to return all of the properties.

# The API:
GET /api/network/fc/logins

# The call:
curl -X GET "https://<mgmt-ip>/api/network/fc/logins?igroups.name=igroup1&fields=*" -H "Accept: application/hal+json"

# The response:
{
"records": [
  {
    "svm": {
      "uuid": "056403da-83a7-4b13-bc78-6a93e8ea3596",
      "name": "svm1",
      "_links": {
        "self": {
          "href": "/api/svm/svms/056403da-83a7-4b13-bc78-6a93e8ea3596"
        }
      }
    },
    "interface": {
      "uuid": "01056403-1383-bc4b-786a-93e8ea35969d",
      "name": "lif2",
      "wwpn": "8b:21:2f:07:00:00:00:00",
      "_links": {
        "self": {
          "href": "/api/network/fc/interfaces/01056403-1383-bc4b-786a-93e8ea35969d"
        }
      }
    },
    "initiator": {
      "wwpn": "8b:21:2f:07:00:00:00:00",
      "wwnn": "95:21:2f:07:00:00:00:00",
      "comment": "Example information about this initiator"
    },
    "igroups": [
      {
        "uuid": "243bbb8a-46e9-4b2d-a508-a62dc93df9d1",
        "name": "igroup1",
        "_links": {
          "self": {
            "href": "/api/protocols/san/igroups/243bbb8a-46e9-4b2d-a508-a62dc93df9d1"
          }
        }
      }
    ],
    "port_address": "8aa53",
    "protocol": "fcp",
    "_links": {
      "self": {
        "href": "/api/network/fc/logins/01056403-1383-bc4b-786a-93e8ea35969d/8b%3A21%3A2f%3A07%3A00%3A00%3A00%3A00"
      }
    }
  }
],
"num_records": 1,
"_links": {
  "self": {
    "href": "/api/network/fc/logins?igroups.name=igroup1&fields=*"
  }
}
}