Skip to main content
REST API reference
A newer release of this product is available.

Update broadcast domain properties

PDFs

PATCH /network/ethernet/broadcast-domains/{uuid}

Updates the properties of a broadcast domain.

  • network port broadcast-domain modify

  • network port broadcast-domain rename

Learn more

Parameters

Name Type In Required Description

uuid

string

path

True

Broadcast domain UUID

Request Body

Name Type Description

_links

_links

ipspace

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 
{
  "_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"
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP 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.
Name Type Description

error

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

self

href

ipspace

Applies to both SVM and cluster-scoped objects. Either the UUID or name is supplied on input.

Name Type Description

_links

_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

_links

name

string

node

node

uuid

string

broadcast_domain

Set of ports that will receive a broadcast Ethernet packet from any of them

Name Type Description

_links

_links

ipspace

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.