Update broadcast domain properties
Suggest changes
PDFs
PATCH /network/ethernet/broadcast-domains/{uuid}
Introduced In: 9.6
Updates the properties of a broadcast domain.
Related ONTAP commands
-
network port broadcast-domain modify -
network port broadcast-domain rename -
network port broadcast-domain move
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
uuid |
string |
path |
True |
Broadcast domain UUID |
Request Body
| Name | Type | Description |
|---|---|---|
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 |
Example request
{
"ipspace": {
"name": "exchange",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"mtu": "1500",
"name": "bd1",
"ports": [
{
"name": "e1b",
"node": {
"name": "node1"
},
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}
],
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}Response
Status: 200, OkError
Status: DefaultONTAP Error Response Codes
| Error Code | Description |
|---|---|
1377267 |
The specified IPspace does not exist. |
1377269 |
Failed to lookup the specified IPspace. |
1377560 |
Broadcast domain already exists in specified IPspace. |
1377605 |
Moving the system-generated broadcast domain to another IPspace is not supported. |
1967082 |
The specified ipspace.name does not match the IPspace name of ipspace.uuid. |
1967150 |
The specified ipspace.uuid is not valid. |
1967151 |
The specified ipspace.uuid and ipspace.name do not match. |
1967152 |
Patching IPspace for a broadcast domain requires an effective cluster version of 9.7 or later. |
Definitions
See Definitions
href
| Name | Type | Description |
|---|---|---|
href |
string |
_links
ipspace
Applies to both SVM and cluster-scoped objects. Either the UUID or name is supplied on input.
| Name | Type | Description |
|---|---|---|
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 |
|---|---|---|
name |
string |
|
node |
||
uuid |
string |
broadcast_domain
Set of ports that will receive a broadcast Ethernet packet from any of them
| Name | Type | Description |
|---|---|---|
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. |