Neutron Port

Media Type
[application/vnd.org.midonet.neutron.Port-v1+json]
Collection Media Type
[application/vnd.org.midonet.neutron.Ports-v1+json]
GET     /neutron/ports
GET     /neutron/ports/:portId
POST    /neutron/ports
PUT     /neutron/ports/:portId
DELETE  /neutron/ports/:portid
Field NameTypePOST/PUTRequiredDescription

id

UUID

POST

No

A unique identifier of the resource. If this field is omitted in the POST request, a random UUID is generated

mac_address

String

POST/PUT

Yes

The physical (MAC() address of the instance attached to this port.

network_id

UUID

POST

Yes

The identifier of the Neutron network to whcih this port belongs.

tenant_id

String

POST

Yes

The identifier of the tenant that owns the port.

name

String

POST/PUT

No

The name of the port.

admin_state_up

Boolean

POST/PUT

No

The administrative state of the port. The default is true (up).

allowed_address_pairs

Array of (String, String)

POST/PUT

No

The list of address pairs that are allowed to send packets through this port. Each array element is a JSON specifying the ip_address and mac_address, such as { "ip_address": "10.0.0.100", "mac_address": "00:11:22:33:44:55" }.

binding:profile

(String)

POST

No

The binding information for this port. Currently is a JSON with an interface_name field indicating the physical interface to which the port is bound.

binding:host_id

String

POST

No

The identifier of the compute host where the port is bound.

device_id

String

POST

No

The identifier of the device that owns the port.

device_owner

String

POST

No

The device owner.

extra_dhcp_opts

Array of (String, String)

POST

No

The list of additional DHCP options. Each array element is a JSON object which includes the opt_name and opt_value.

fixed_ips

Array of (String, UUID)

POST/PUT

No

The list of IP addresses assigned to this port. Each array element is a JSON indicating the ip_address and subnet_id, such as { "ip_address": "10.0.0.100", "subnet_id": "00000000-0000-0000-0000-000000000000" }.

port_security_enabled

Boolean

POST

No

Indicates whether the port security is enabled. The default is true.

security_groups

Array of UUID

POST

No

The list of security groups applied to this port.

status

String

  

The status of this resource. This field is currently unused.

Questions? Discuss on Mailing Lists or Chat.
Found an error? Report a bug.