Get started
List the IP interfaces
Contributors
Suggest changes
PDFs
You can retrieve the IP LIFs assigned to the cluster and SVMs. You might do this to confirm your network configuration or when planning to add another LIF.
HTTP method and endpoint
This REST API call uses the following method and endpoint.
| HTTP method | Path |
|---|---|
GET |
/api/network/ip/interfaces |
Processing type
Synchronous
Additional input parameters for the Curl examples
In addition to the parameters common with all REST API calls, the following parameters are also used in the curl examples for this step.
| Parameter | Type | Required | Description |
|---|---|---|---|
fields |
Query |
No |
Return a limited list of the relevant configuration values. |
Curl example: return all LIFs with the default configuration values
curl --request GET \
--location "https://$FQDN_IP/api/network/ip/interfaces" \
--include \
--header "Accept: */*" \
--header "Authorization: Basic $BASIC_AUTH"Curl example: Return all LIFs with four specific configuration values
curl --request GET \
--location "https://$FQDN_IP/api/network/ip/interfaces?fields=name,scope,svm.name,ip.address" \
--include \
--header "Accept: */*" \
--header "Authorization: Basic $BASIC_AUTH"JSON output example
{
"records": [
{
"uuid": "5ded9e38-999e-11ee-acad-005056ae6bd8",
"name": "sti214-vsim-sr027o_mgmt1",
"ip": {
"address": "172.29.151.116"
},
"scope": "cluster",
"_links": {
"self": {
"href": "/api/network/ip/interfaces/5ded9e38-999e-11ee-acad-005056ae6bd8"
}
}
},
{
"uuid": "bb03c162-999e-11ee-acad-005056ae6bd8",
"name": "cluster_mgmt",
"ip": {
"address": "172.29.186.156"
},
"scope": "cluster",
"_links": {
"self": {
"href": "/api/network/ip/interfaces/bb03c162-999e-11ee-acad-005056ae6bd8"
}
}
},
{
"uuid": "c5ffbd03-999e-11ee-acad-005056ae6bd8",
"name": "sti214-vsim-sr027o_data1",
"ip": {
"address": "172.29.186.150"
},
"scope": "svm",
"svm": {
"name": "vs0"
},
"_links": {
"self": {
"href": "/api/network/ip/interfaces/c5ffbd03-999e-11ee-acad-005056ae6bd8"
}
}
},
{
"uuid": "c6612abe-999e-11ee-acad-005056ae6bd8",
"name": "sti214-vsim-sr027o_data2",
"ip": {
"address": "172.29.186.151"
},
"scope": "svm",
"svm": {
"name": "vs0"
},
"_links": {
"self": {
"href": "/api/network/ip/interfaces/c6612abe-999e-11ee-acad-005056ae6bd8"
}
}
},
{
"uuid": "c6b21b94-999e-11ee-acad-005056ae6bd8",
"name": "sti214-vsim-sr027o_data3",
"ip": {
"address": "172.29.186.152"
},
"scope": "svm",
"svm": {
"name": "vs0"
},
"_links": {
"self": {
"href": "/api/network/ip/interfaces/c6b21b94-999e-11ee-acad-005056ae6bd8"
}
}
},
{
"uuid": "c7025322-999e-11ee-acad-005056ae6bd8",
"name": "sti214-vsim-sr027o_data4",
"ip": {
"address": "172.29.186.153"
},
"scope": "svm",
"svm": {
"name": "vs0"
},
"_links": {
"self": {
"href": "/api/network/ip/interfaces/c7025322-999e-11ee-acad-005056ae6bd8"
}
}
},
{
"uuid": "c752cc66-999e-11ee-acad-005056ae6bd8",
"name": "sti214-vsim-sr027o_data5",
"ip": {
"address": "172.29.186.154"
},
"scope": "svm",
"svm": {
"name": "vs0"
},
"_links": {
"self": {
"href": "/api/network/ip/interfaces/c752cc66-999e-11ee-acad-005056ae6bd8"
}
}
},
{
"uuid": "c7a03719-999e-11ee-acad-005056ae6bd8",
"name": "sti214-vsim-sr027o_data6",
"ip": {
"address": "172.29.186.155"
},
"scope": "svm",
"svm": {
"name": "vs0"
},
"_links": {
"self": {
"href": "/api/network/ip/interfaces/c7a03719-999e-11ee-acad-005056ae6bd8"
}
}
},
{
"uuid": "ccd4c59c-999e-11ee-acad-005056ae6bd8",
"name": "sti214-vsim-sr027o_data4_inet6",
"ip": {
"address": "fd20:8b1e:b255:300f::ac5"
},
"scope": "svm",
"svm": {
"name": "vs0"
},
"_links": {
"self": {
"href": "/api/network/ip/interfaces/ccd4c59c-999e-11ee-acad-005056ae6bd8"
}
}
},
{
"uuid": "d9144c30-999e-11ee-acad-005056ae6bd8",
"name": "sti214-vsim-sr027o_data6_inet6",
"ip": {
"address": "fd20:8b1e:b255:300f::ac7"
},
"scope": "svm",
"svm": {
"name": "vs0"
},
"_links": {
"self": {
"href": "/api/network/ip/interfaces/d9144c30-999e-11ee-acad-005056ae6bd8"
}
}
},
{
"uuid": "d961c13b-999e-11ee-acad-005056ae6bd8",
"name": "sti214-vsim-sr027o_data1_inet6",
"ip": {
"address": "fd20:8b1e:b255:300f::ac2"
},
"scope": "svm",
"svm": {
"name": "vs0"
},
"_links": {
"self": {
"href": "/api/network/ip/interfaces/d961c13b-999e-11ee-acad-005056ae6bd8"
}
}
},
{
"uuid": "d9ac8d6a-999e-11ee-acad-005056ae6bd8",
"name": "sti214-vsim-sr027o_data5_inet6",
"ip": {
"address": "fd20:8b1e:b255:300f::ac6"
},
"scope": "svm",
"svm": {
"name": "vs0"
},
"_links": {
"self": {
"href": "/api/network/ip/interfaces/d9ac8d6a-999e-11ee-acad-005056ae6bd8"
}
}
},
{
"uuid": "d9fce1a3-999e-11ee-acad-005056ae6bd8",
"name": "sti214-vsim-sr027o_data2_inet6",
"ip": {
"address": "fd20:8b1e:b255:300f::ac3"
},
"scope": "svm",
"svm": {
"name": "vs0"
},
"_links": {
"self": {
"href": "/api/network/ip/interfaces/d9fce1a3-999e-11ee-acad-005056ae6bd8"
}
}
},
{
"uuid": "da4995a0-999e-11ee-acad-005056ae6bd8",
"name": "sti214-vsim-sr027o_data3_inet6",
"ip": {
"address": "fd20:8b1e:b255:300f::ac4"
},
"scope": "svm",
"svm": {
"name": "vs0"
},
"_links": {
"self": {
"href": "/api/network/ip/interfaces/da4995a0-999e-11ee-acad-005056ae6bd8"
}
}
},
{
"uuid": "da9e7afd-999e-11ee-acad-005056ae6bd8",
"name": "sti214-vsim-sr027o_cluster_mgmt_inet6",
"ip": {
"address": "fd20:8b1e:b255:300f::ac8"
},
"scope": "cluster",
"_links": {
"self": {
"href": "/api/network/ip/interfaces/da9e7afd-999e-11ee-acad-005056ae6bd8"
}
}
},
{
"uuid": "e6db58b4-999e-11ee-acad-005056ae6bd8",
"name": "sti214-vsim-sr027o_mgmt1_inet6",
"ip": {
"address": "fd20:8b1e:b255:3008::1a0"
},
"scope": "cluster",
"_links": {
"self": {
"href": "/api/network/ip/interfaces/e6db58b4-999e-11ee-acad-005056ae6bd8"
}
}
}
],
"num_records": 16,
"_links": {
"self": {
"href": "/api/network/ip/interfaces?fields=name,scope,svm.name,ip.address"
}
}
}