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

Retrieve broadcast domain details

Contributors

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

Introduced In: 9.6

Retrieves details of a broadcast domain.

  • network port broadcast-domain show

Parameters

Name Type In Required Description

uuid

string

path

True

Broadcast domain UUID

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
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 response
{
  "_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

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

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

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.