Retrieve IPspaces for a cluster
Retrieves IPspaces for a cluster to access the network configurations associated with the entire cluster. This is useful for managing and reviewing the network segmentation and isolation settings in your environment.
HTTP method and endpoint
GET /network/ipspaces
Introduced in
ONTAP 9.6
Usage notes
Retrieves a collection of IPspaces for the entire cluster.
Related ONTAP commands
-
network ipspace show
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
uuid |
string |
query |
False |
Filter by uuid |
name |
string |
query |
False |
Filter by name |
tcp_stack |
string |
query |
False |
Filter by tcp_stack
|
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[ipspace] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "ipspace1",
"tcp_stack": "freebsd",
"uuid": "1cd8a442-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"
}
}
Definitions
See Definitions
href
| Name | Type | Description |
|---|---|---|
href |
string |
_links
| Name | Type | Description |
|---|---|---|
next |
||
self |
_links
| Name | Type | Description |
|---|---|---|
self |
ipspace
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
IPspace name |
tcp_stack |
string |
The TCP stack used by the IPspace. |
uuid |
string |
The UUID that uniquely identifies the IPspace. |
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
returned_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. |