The Port Class

The Port class inherits from Resource.

class, **attrs)

The base resource

Parameters:_synchronized (bool) – This is not intended to be used directly. See new() and existing().
allowed_address_pairs = None

Allowed address pairs.

binding_host_id = None

The ID of the host where the port is allocated. In some cases, different implementations can run on different hosts.

binding_profile = None

A dictionary the enables the application running on the specified host to pass and receive vif port-specific information to the plug-in. Type: dict

binding_vif_details = None

Read-only. A dictionary that enables the application to pass information about functions that the Networking API provides. To enable or disable port filtering features such as security group and anti-MAC/IP spoofing, specify port_filter: True or port_filter: False. Type: dict

binding_vif_type = None

Read-only. The vif type for the specified port.

binding_vnic_type = None

The vnic type that is bound to the neutron port.

In POST and PUT operations, specify a value of normal (virtual nic), direct (pci passthrough), or macvtap (virtual interface with a tap-like software interface). These values support SR-IOV PCI passthrough networking. The ML2 plug-in supports the vnic_type.

In GET operations, the binding:vnic_type extended attribute is visible to only port owners and administrative users.

created_at = None

Timestamp when the port was created.

data_plane_status = None

Underlying data plane status of this port.

description = None

The port description.

device_id = None

Device ID of this port.

device_owner = None

Device owner of this port (e.g. network:dhcp).

dns_assignment = None

DNS assignment for the port.

dns_name = None

DNS name for the port.

extra_dhcp_opts = None

Extra DHCP options.

ip_address = None

IP addresses of an allowed address pair.

fixed_ips = None

IP addresses for the port. Includes the IP address and subnet ID.

is_admin_state_up = None

The administrative state of the port, which is up True or down False. Type: bool

is_port_security_enabled = None

The port security status, which is enabled True or disabled False. Type: bool Default: False

mac_address = None

The MAC address of an allowed address pair.

name = None

The port name.

network_id = None

The ID of the attached network.

project_id = None

The ID of the project who owns the network. Only administrative users can specify a project ID other than their own.

option_name = None

The extra DHCP option name.

option_value = None

The extra DHCP option value.

qos_policy_id = None

The ID of the QoS policy attached to the port.

revision_number = None

Revision number of the port. Type: int

security_group_ids = None

The IDs of any attached security groups. Type: list of strs of the security group IDs

status = None

The port status. Value is ACTIVE or DOWN.

subnet_id = None

The ID of the subnet. If you specify only a subnet UUID, OpenStack networking allocates an available IP from that subnet to the port. If you specify both a subnet ID and an IP address, OpenStack networking tries to allocate the address to the port.

trunk_details = None

Read-only. The trunk referring to this parent port and its subports. Present for trunk parent ports if trunk-details extension is loaded. Type: dict with keys: trunk_id, sub_ports. sub_ports is a list of dicts with keys: port_id, segmentation_type, segmentation_id, mac_address

updated_at = None

Timestamp when the port was last updated.

tags = None

A list of assocaited tags Type: list of tag strings

Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.