Retrieve initiator groups
GET /protocols/san/igroups
Introduced In: 9.6
Retrieves initiator groups.
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.
-
connectivity_tracking.*
-
igroups.*
-
lun_maps.*
-
parent_igroups.*
-
target.*
Related ONTAP commands
-
lun igroup show
-
lun mapping show
Learn more
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
portset.name |
string |
query |
False |
Filter by portset.name
|
portset.uuid |
string |
query |
False |
Filter by portset.uuid
|
lun_maps.lun.name |
string |
query |
False |
Filter by lun_maps.lun.name |
lun_maps.lun.node.uuid |
string |
query |
False |
Filter by lun_maps.lun.node.uuid |
lun_maps.lun.node.name |
string |
query |
False |
Filter by lun_maps.lun.node.name |
lun_maps.lun.uuid |
string |
query |
False |
Filter by lun_maps.lun.uuid |
lun_maps.logical_unit_number |
integer |
query |
False |
Filter by lun_maps.logical_unit_number |
connectivity_tracking.required_nodes.uuid |
string |
query |
False |
Filter by connectivity_tracking.required_nodes.uuid
|
connectivity_tracking.required_nodes.name |
string |
query |
False |
Filter by connectivity_tracking.required_nodes.name
|
connectivity_tracking.connection_state |
string |
query |
False |
Filter by connectivity_tracking.connection_state
|
connectivity_tracking.alerts.summary.code |
string |
query |
False |
Filter by connectivity_tracking.alerts.summary.code
|
connectivity_tracking.alerts.summary.message |
string |
query |
False |
Filter by connectivity_tracking.alerts.summary.message
|
connectivity_tracking.alerts.summary.arguments.message |
string |
query |
False |
Filter by connectivity_tracking.alerts.summary.arguments.message
|
connectivity_tracking.alerts.summary.arguments.code |
string |
query |
False |
Filter by connectivity_tracking.alerts.summary.arguments.code
|
uuid |
string |
query |
False |
Filter by uuid |
protocol |
string |
query |
False |
Filter by protocol |
comment |
string |
query |
False |
Filter by comment
|
igroups.uuid |
string |
query |
False |
Filter by igroups.uuid
|
igroups.comment |
string |
query |
False |
Filter by igroups.comment
|
igroups.name |
string |
query |
False |
Filter by igroups.name
|
replication.error.summary.code |
string |
query |
False |
Filter by replication.error.summary.code
|
replication.error.summary.message |
string |
query |
False |
Filter by replication.error.summary.message
|
replication.error.summary.arguments.message |
string |
query |
False |
Filter by replication.error.summary.arguments.message
|
replication.error.summary.arguments.code |
string |
query |
False |
Filter by replication.error.summary.arguments.code
|
replication.error.igroup.local_svm |
boolean |
query |
False |
Filter by replication.error.igroup.local_svm
|
replication.error.igroup.uuid |
string |
query |
False |
Filter by replication.error.igroup.uuid
|
replication.error.igroup.name |
string |
query |
False |
Filter by replication.error.igroup.name
|
replication.peer_svm.uuid |
string |
query |
False |
Filter by replication.peer_svm.uuid
|
replication.peer_svm.name |
string |
query |
False |
Filter by replication.peer_svm.name
|
replication.state |
string |
query |
False |
Filter by replication.state
|
svm.uuid |
string |
query |
False |
Filter by svm.uuid |
svm.name |
string |
query |
False |
Filter by svm.name |
os_type |
string |
query |
False |
Filter by os_type |
parent_igroups.comment |
string |
query |
False |
Filter by parent_igroups.comment
|
parent_igroups.uuid |
string |
query |
False |
Filter by parent_igroups.uuid
|
parent_igroups.name |
string |
query |
False |
Filter by parent_igroups.name
|
supports_igroups |
boolean |
query |
False |
Filter by supports_igroups
|
delete_on_unmap |
boolean |
query |
False |
Filter by delete_on_unmap |
target.product_id |
string |
query |
False |
Filter by target.product_id
|
target.vendor_id |
string |
query |
False |
Filter by target.vendor_id
|
target.firmware_revision |
string |
query |
False |
Filter by target.firmware_revision
|
initiators.connectivity_tracking.connection_state |
string |
query |
False |
Filter by initiators.connectivity_tracking.connection_state
|
initiators.comment |
string |
query |
False |
Filter by initiators.comment
|
initiators.name |
string |
query |
False |
Filter by initiators.name
|
initiators.igroup.uuid |
string |
query |
False |
Filter by initiators.igroup.uuid |
initiators.igroup.name |
string |
query |
False |
Filter by initiators.igroup.name
|
initiators.proximity.local_svm |
boolean |
query |
False |
Filter by initiators.proximity.local_svm
|
initiators.proximity.peer_svms.uuid |
string |
query |
False |
Filter by initiators.proximity.peer_svms.uuid
|
initiators.proximity.peer_svms.name |
string |
query |
False |
Filter by initiators.proximity.peer_svms.name
|
name |
string |
query |
False |
Filter by name
|
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 |
The number of records in the response. |
records |
array[igroup] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"comment": "string",
"connectivity_tracking": {
"alerts": [
{
"summary": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist"
}
}
],
"connection_state": "string",
"required_nodes": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}
]
},
"igroups": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"comment": "string",
"igroups": [
null
],
"name": "igroup1",
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
}
],
"initiators": [
{
"_links": {
"connectivity_tracking": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"comment": "string",
"connectivity_tracking": {
"connection_state": "string"
},
"igroup": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "igroup1",
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
},
"name": "iqn.1998-01.com.corp.iscsi:name1",
"proximity": {
"peer_svms": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "peer1",
"uuid": "4204cf77-4c82-9bdb-5644-b5a841c097a9"
}
]
}
}
],
"lun_maps": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"logical_unit_number": 0,
"lun": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "lun1",
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
}
}
],
"name": "igroup1",
"os_type": "string",
"parent_igroups": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"comment": "string",
"name": "igroup1",
"parent_igroups": [
null
],
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
}
],
"portset": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "portset1",
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
},
"protocol": "string",
"replication": {
"error": {
"igroup": {
"name": "igroup1",
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
},
"summary": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist"
}
},
"peer_svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "peer1",
"uuid": "4204cf77-4c82-9bdb-5644-b5a841c097a9"
},
"state": "string"
},
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"target": {
"firmware_revision": "9111",
"product_id": "LUN C-Mode",
"vendor_id": "NETAPP"
},
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
}
]
}
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"
}
}