openstack.baremetal.v1.port

openstack.baremetal.v1.port

The Port Class

The Port class inherits from Resource.

class openstack.baremetal.v1.port.Port(_synchronized=False, connection=None, **attrs)

The base resource

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

  • connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of self._connection in Resource code should protect itself with a check for None.

resources_key = 'ports'

Plural form of key for resource.

base_path = '/ports'

The base part of the URI for this resource.

allow_create = True

Allow create operation for this resource.

allow_fetch = True

Allow get operation for this resource.

allow_commit = True

Allow update operation for this resource.

allow_delete = True

Allow delete operation for this resource.

allow_list = True

Allow list operation for this resource.

allow_patch = True

Allow patch operation for this resource.

commit_method = 'PATCH'

Method for committing a resource (PUT, PATCH, POST)

commit_jsonpatch = True

Whether commit uses JSON patch format.

address

The physical hardware address of the network port, typically the hardware MAC address.

created_at

Timestamp at which the port was created.

extra

A set of one or more arbitrary metadata key and value pairs.

id

The UUID of the port

internal_info

Internal metadata set and stored by the port. This field is read-only. Added in API microversion 1.18.

is_pxe_enabled

Whether PXE is enabled on the port. Added in API microversion 1.19.

A list of relative links, including the self and bookmark links.

The port bindig profile. If specified, must contain switch_id and port_id fields. switch_info field is an optional string field to be used to store vendor specific information. Added in API microversion 1.19.

node_id

The UUID of node this port belongs to

physical_network

The name of physical network this port is attached to. Added in API microversion 1.34.

port_group_id

The UUID of PortGroup this port belongs to. Added in API microversion 1.24.

updated_at

Timestamp at which the port was last updated.

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.