class Port extends OperatorResource implements Creatable, Updateable, Deletable, Listable, Retrievable

Traits

Contains reusable functionality for resources that have long operations which require waiting in order to reach a particular state.

Properties

$status string The port status. Value is ACTIVE or DOWN.
$name string The port name.
$adminStateUp bool The administrative state of the port, which is up (true) or down (false).
$networkId string The UUID of the attached network.
$tenantId string The UUID of the tenant who owns the network. Only administrative users can specify a tenant UUID other than their own.
$extraDhcpOpts array A set of zero or more extra DHCP option pairs. An option pair consists of an option value and name.
$deviceOwner string The UUID of the entity that uses this port. For example, a DHCP agent.
$macAddress string The MAC address of the port.
$fixedIps array The IP addresses for the port. Includes the IP address and UUID of the subnet.
$id string The UUID of the port.
$securityGroups array The UUIDs of any attached security groups.
$deviceId string The UUID of the device that uses this port. For example, a virtual server.
$portSecurityEnabled bool The port security status. The status is enabled (true) or disabled (false).

Methods

create (array $userOptions) : Creatable

Create a new resource according to the configuration set in the options.

bulkCreate (array $userOptions)

No description

retrieve () : void

Retrieve details of the current resource from the remote API.

update () : void

Update the current resource with the configuration set out in the user options.

delete () : void

Permanently delete this resource.

Details

create(array $userOptions)

Create a new resource according to the configuration set in the options.

Parameters

$userOptions array

Return value

Creatable

Example code

$creatable = $port->create($userOptions);

bulkCreate(array $userOptions)

Parameters

$userOptions array

Example code

$port->bulkCreate($userOptions);

retrieve()

Retrieve details of the current resource from the remote API.

Return value

void

Example code

$port->retrieve();

update()

Update the current resource with the configuration set out in the user options.

Return value

void

Example code

$port->update();

delete()

Permanently delete this resource.

Return value

void

Example code

$port->delete();