Retrieve broadcast domains for the entire cluster
GET /network/ethernet/broadcast-domains
Retrieves a collection of broadcast domains for the entire cluster.
Related ONTAP commands
-
network port broadcast-domain show
Learn more
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
ports.node.name |
string |
query |
False |
Filter by ports.node.name |
ports.name |
string |
query |
False |
Filter by ports.name |
ports.uuid |
string |
query |
False |
Filter by ports.uuid |
name |
string |
query |
False |
Filter by name |
mtu |
integer |
query |
False |
Filter by mtu |
uuid |
string |
query |
False |
Filter by uuid |
ipspace.uuid |
string |
query |
False |
Filter by ipspace.uuid |
ipspace.name |
string |
query |
False |
Filter by ipspace.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 |
|
records |
array[broadcast_domain] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"records": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"ipspace": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "exchange",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"mtu": 1500,
"name": "bd1",
"ports": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "e1b",
"node": {
"name": "node1"
},
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}
],
"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
Applies to both SVM and cluster-scoped objects. Either the UUID or name is supplied on input.
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
IPspace name |
uuid |
string |
IPspace UUID |
node
Name | Type | Description |
---|---|---|
name |
string |
Name of node on which the port is located. |
ports
Port UUID along with readable names
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
|
node |
||
uuid |
string |
broadcast_domain
Set of ports that will receive a broadcast Ethernet packet from any of them
Name | Type | Description |
---|---|---|
_links |
||
ipspace |
Applies to both SVM and cluster-scoped objects. Either the UUID or name is supplied on input. |
|
mtu |
integer |
Maximum transmission unit, largest packet size on this network |
name |
string |
Name of the broadcast domain, scoped to its IPspace |
ports |
array[ports] |
Ports that belong to the broadcast domain |
uuid |
string |
Broadcast domain UUID |
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. |