Retrieve FC logins
GET /network/fc/logins
Retrieves FC logins.
Related ONTAP commands
-
vserver fcp initiator show
Learn more
-
NVMe: DOC /network/fc/logins
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
igroups.name |
string |
query |
False |
Filter by igroups.name |
igroups.uuid |
string |
query |
False |
Filter by igroups.uuid |
initiator.port_address |
string |
query |
False |
Filter by initiator.port_address |
initiator.wwnn |
string |
query |
False |
Filter by initiator.wwnn |
initiator.wwpn |
string |
query |
False |
Filter by initiator.wwpn |
initiator.aliases |
string |
query |
False |
Filter by initiator.aliases |
protocol |
string |
query |
False |
Filter by protocol |
svm.uuid |
string |
query |
False |
Filter by svm.uuid |
svm.name |
string |
query |
False |
Filter by svm.name |
interface.name |
string |
query |
False |
Filter by interface.name |
interface.wwpn |
string |
query |
False |
Filter by interface.wwpn |
interface.uuid |
string |
query |
False |
Filter by interface.uuid |
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. |
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. |
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
Response
Status: 200, Ok
Name | Type | Description |
---|---|---|
_links |
||
num_records |
integer |
Number of records. |
records |
array[fc_login] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"records": [
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"igroups": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "igroup1",
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
}
],
"initiator": {
"aliases": [
"alias1"
],
"port_address": "5060A",
"wwnn": "2f:a0:00:a0:98:0b:56:13",
"wwpn": "2f:a0:00:a0:98:0b:56:13"
},
"interface": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "lif1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412",
"wwpn": "20:00:00:50:56:b4:13:a8"
},
"protocol": "string",
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
}
}
]
}
Error
Status: Default, Error
Name | Type | Description |
---|---|---|
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 |
||
self |
_links
Name | Type | Description |
---|---|---|
self |
igroups
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
The name of the initiator group. |
uuid |
string |
The unique identifier of the initiator group. |
initiator
Information about the logged in FC initiator.
Name | Type | Description |
---|---|---|
aliases |
array[string] |
The logged in initiator world wide port name (WWPN) aliases. |
port_address |
string |
The port address of the initiator's FC port. Each port in an FC switched fabric has its own unique port address for routing purposes. The 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 initiator port. This is useful for obtaining statistics and diagnostic information from FC switches. This is a hexadecimal encoded numeric value. |
wwnn |
string |
The logged in initiator world wide node name (WWNN). |
wwpn |
string |
The logged in initiator WWPN. |
interface
An FC interface.
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
The name of the FC interface. |
uuid |
string |
The unique identifier of the FC interface. |
wwpn |
string |
The WWPN of the FC interface. |
svm
SVM, applies only to SVM-scoped objects.
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
The name of the SVM. |
uuid |
string |
The unique identifier of the SVM. |
fc_login
A Fibre Channel (FC) login represents a connection formed by an FC initiator that has successfully logged in to ONTAP. This represents the FC login on which higher-level protocols such as Fibre Channel Protocol and NVMe over Fibre Channel (NVMe/FC) rely.
Name | Type | Description |
---|---|---|
_links |
||
igroups |
array[igroups] |
The initiator groups in which the initiator is a member. |
initiator |
Information about the logged in FC initiator. |
|
interface |
An FC interface. |
|
protocol |
string |
The data protocol used to perform the login. |
svm |
SVM, applies only to SVM-scoped objects. |
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. |