1. class
  2. OpenStack
  3. Networking
  4. v2
  5. Extensions
  6. Layer3
  7. Models
  8. Router

Router

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

Traits

OpenStack\Common\Resource\HasWaiterTrait
Contains reusable functionality for resources that have long operations which require waiting in order to reach a particular state.
OpenStack\Common\Api\OperatorTrait

Properties

$status string
$externalGatewayInfo GatewayInfo
$name string
$adminStateUp string
$tenantId string
$routes array
$id string

Methods

create (array $userOptions) : Creatable

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

update () : void

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

retrieve () : void

Retrieve details of the current resource from the remote API.

delete () : void

Permanently delete this resource.

addInterface (array $userOptions)

No description

removeInterface (array $userOptions)

No description

Details

View source
create(array $userOptions)

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

Parameters

$userOptions array

Return value

Creatable

Example code

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

View source
update()

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

Return value

void

Example code

$router->update();

View source
retrieve()

Retrieve details of the current resource from the remote API.

Return value

void

Example code

$router->retrieve();

View source
delete()

Permanently delete this resource.

Return value

void

Example code

$router->delete();

View source
addInterface(array $userOptions)

Parameters

$userOptions array {see \OpenStack\Networking\v2\Extensions\Layer3\Api::putAddInterface}

Example code

$router->addInterface($userOptions);

View source
removeInterface(array $userOptions)

Parameters

$userOptions array {see \OpenStack\Networking\v2\Extensions\Layer3\Api::putRemoveInterface}

Example code

$router->removeInterface($userOptions);