Skip to content
Equnix Metal
show

Ports copied!

Port ManagementCheck out the product docs to learn more about Port configurations.

Retrieve a port copied!

GET
/ports/{id}

Returns a port

  • Parameters
  • id
    string  (required) in path

    Port UUID

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Assign a port to virtual network copied!

POST
/ports/{id}/assign

Assign a port for a hardware to virtual network.

  • Parameters
  • id
    string  (required) in path

    Port UUID

    vnid
     (required) in body

    Virtual Network ID. May be the UUID of the Virtual Network record, or the VLAN value itself (ex: '1001').

    {
        "vnid": "string"
    }

Unassign a port copied!

POST
/ports/{id}/unassign

Unassign a port for a hardware.

  • Parameters
  • id
    string  (required) in path

    Port UUID

    vnid
     (required) in body

    Virtual Network ID. May be the UUID of the Virtual Network record, or the VLAN value itself (ex: '1001').

    {
        "vnid": "string"
    }

Disabling bonding copied!

POST
/ports/{id}/disbond

Disabling bonding for one or all ports

  • Parameters
  • id
    string  (required) in path

    Port UUID

    bulk_disable
    boolean in query

    disable both ports

Enabling bonding copied!

POST
/ports/{id}/bond

Enabling bonding for one or all ports

  • Parameters
  • id
    string  (required) in path

    Port UUID

    bulk_enable
    boolean in query

    enable both ports

Convert to Layer 2 copied!

POST
/ports/{id}/convert/layer-2

Converts a bond port to Layer 2. IP assignments of the port will be removed.

  • Parameters
  • id
    string  (required) in path

    Port UUID

    vnid
    in body

    Virtual Network ID

    {
        "vnid": "string"
    }

Convert to Layer 3 copied!

POST
/ports/{id}/convert/layer-3

Converts a bond port to Layer 3. VLANs must first be unassigned.

  • Parameters
  • id
    string  (required) in path

    Port UUID

    request_ips
    in body

    IPs to request

    {
        "request_ips": [
            {
                "address_family": "integer",
                "public": "boolean"
            }
        ]
    }

Assign a native VLAN copied!

POST
/ports/{id}/native-vlan

Sets a virtual network on this port as a "native VLAN". The VLAN must have already been assigned using the using the "Assign a port to a virtual network" operation.

  • Parameters
  • id
    string  (required) in path

    Port UUID

    vnid
    string  (required) in query

    Virtual Network ID. May be the UUID of the Virtual Network record, or the VLAN value itself (ex: '1001').

Remove native VLAN copied!

DELETE
/ports/{id}/native-vlan

Removes the native VLAN from this port

  • Parameters
  • id
    string  (required) in path

    Port UUID