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

Create a new VLAN or LAG

Contributors
PDFs

POST /network/ethernet/ports

Creates a new VLAN (such as node1:e0a-100) or LAG (ifgrp, such as node2:a0a).

Required properties

  • node - Node the port will be created on.

  • broadcast_domain - Broadcast domain the port is associated with.

  • type - Defines if a VLAN or LAG will be created:

    • VLAN

      • vlan.base_port - Physical port or LAG the VLAN will be created on.

      • vlan.tag - Tag used to identify VLAN on the base port.

    • LAG

      • lag.mode - Policy for the LAG that will be created.

      • lag.distribution_policy - Indicates how the packets are distributed between ports.

      • lag.member_ports - Set of ports the LAG consists of.

  • network port ifgrp create

  • network port vlan create

Learn more

Parameters

Name Type In Required Description

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

Request Body

Name Type Description

_links

_links

broadcast_domain

broadcast_domain

Broadcast domain UUID along with a readable name. Either the UUID or both names may be provided on input.

enabled

boolean

lag

lag

mac_address

string

mtu

integer

MTU of the port in bytes. Set by broadcast domain.

name

string

Portname, such as e0a, e1b-100 (VLAN on ethernet), a0c (LAG/ifgrp), a0d-200 (vlan on LAG/ifgrp)

node

node

speed

integer

Link speed in Mbps

state

string

Operational state of the port.

type

string

Type of physical or virtual port

uuid

string

Port UUID

vlan

vlan
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "broadcast_domain": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "ipspace": {
      "name": "ipspace1"
    },
    "name": "bd1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "lag": {
    "active_ports": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "e1b",
      "node": {
        "name": "node1"
      },
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    },
    "distribution_policy": "port",
    "member_ports": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "e1b",
      "node": {
        "name": "node1"
      },
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    },
    "mode": "multimode_lacp"
  },
  "mac_address": "01:02:03:04:05:06",
  "mtu": 1500,
  "name": "e1b",
  "node": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "node1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "speed": 1000,
  "state": "up",
  "type": "vlan",
  "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412",
  "vlan": {
    "base_port": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "e1b",
      "node": {
        "name": "node1"
      },
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    },
    "tag": 100
  }
}

Response

Status: 201, Created
Name Type Description

_links

_links

num_records

integer

records

array[port]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "broadcast_domain": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "ipspace": {
        "name": "ipspace1"
      },
      "name": "bd1",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    },
    "lag": {
      "active_ports": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "e1b",
        "node": {
          "name": "node1"
        },
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "distribution_policy": "port",
      "member_ports": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "e1b",
        "node": {
          "name": "node1"
        },
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "mode": "multimode_lacp"
    },
    "mac_address": "01:02:03:04:05:06",
    "mtu": 1500,
    "name": "e1b",
    "node": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "node1",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    },
    "speed": 1000,
    "state": "up",
    "type": "vlan",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412",
    "vlan": {
      "base_port": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "e1b",
        "node": {
          "name": "node1"
        },
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "tag": 100
    }
  }
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

1376361

Port is already a member of a LAG.

1966189

Port is the home port or current port of an interface.

1967083

The specified type is not valid.

1967084

The specified node UUID is not valid.

1967085

The specified node name is not valid.

1967086

Node name and UUID must match if both are provided.

1967087

The specified broadcast domain UUID is not valid.

1967088

The specified broadcast domain name does not exist in the specified IPspace.

1967089

The specified broadcast domain UUID, name, and IPspace name do not match.

1967090

The specified VLAN base port UUID is not valid.

1967091

The specified VLAN base port name and node name are not valid.

1967092

The specified node does not match the node specified for the VLAN base port.

1967093

The specified VLAN base port UUID, name, and VLAN base port node name do not match.

1967094

The specified LAG member port UUID is not valid.

1967095

The specified LAG member port name and node name combination is not valid.

1967096

The specified node does not match the specified LAG member port node.

1967097

The specified LAG member ports UUID, name, and node name do not match.

1967098

VLAN POST operation has failed because admin status could not be set for the specified port.

1967099

Partial success of the VLAN POST operation. Verify the state of the created VLAN for more information.

1967100

LAG POST operation failed because admin status could not be set.

1967101

Partial success of the LAG POST operation. Verify the state of the created LAG for more information.

1967102

POST operation might have left the configuration in an inconsistent state. Check the configuration.

1967148

Failure to remove port from broadcast domain.

1967149

Failure to add port to broadcast domain.

1967175

VLANs cannot be created on ports in the Cluster IPspace.
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

Name Type Description

name

string

Name of the broadcast domain's IPspace

broadcast_domain

Broadcast domain UUID along with a readable name. Either the UUID or both names may be provided on input.

Name Type Description

_links

_links

ipspace

ipspace

name

string

Name of the broadcast domain, scoped to its IPspace

uuid

string

Broadcast domain UUID

node

Name Type Description

name

string

Name of node on which the port is located.

active_ports

Port UUID along with readable names. Either the UUID or both names may be supplied on input.

Name Type Description

_links

_links

name

string

node

node

uuid

string

member_ports

Port UUID along with readable names. Either the UUID or both names may be supplied on input.

Name Type Description

_links

_links

name

string

node

node

uuid

string

lag

Name Type Description

active_ports

array[active_ports]

Active ports of a LAG (ifgrp). (Some member ports may be inactive.)

distribution_policy

string

Policy for mapping flows to ports for outbound packets through a LAG (ifgrp).

member_ports

array[member_ports]

mode

string

Determines how the ports interact with the switch.

node

Name Type Description

_links

_links

name

string

uuid

string

base_port

Port UUID along with readable names. Either the UUID or both names may be supplied on input.

Name Type Description

_links

_links

name

string

node

node

uuid

string

vlan

Name Type Description

base_port

base_port

Port UUID along with readable names. Either the UUID or both names may be supplied on input.

tag

integer

VLAN ID

port

Name Type Description

_links

_links

broadcast_domain

broadcast_domain

Broadcast domain UUID along with a readable name. Either the UUID or both names may be provided on input.

enabled

boolean

lag

lag

mac_address

string

mtu

integer

MTU of the port in bytes. Set by broadcast domain.

name

string

Portname, such as e0a, e1b-100 (VLAN on ethernet), a0c (LAG/ifgrp), a0d-200 (vlan on LAG/ifgrp)

node

node

speed

integer

Link speed in Mbps

state

string

Operational state of the port.

type

string

Type of physical or virtual port

uuid

string

Port UUID

vlan

vlan

_links

Name Type Description

next

href

self

href

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.