Complete User Guide for the Networking Service¶

Client¶

To use the Networking service, you must first instantiate a OpenStack or Rackspace client object.

• If you are working with an OpenStack cloud, instantiate an OpenCloud\OpenStack client as follows:

  use OpenCloud\OpenStack;
  
  $client = new OpenStack('<OPENSTACK CLOUD IDENTITY ENDPOINT URL>', array(
      'username' => '<YOUR OPENSTACK CLOUD ACCOUNT USERNAME>',
      'password' => '<YOUR OPENSTACK CLOUD ACCOUNT PASSWORD>'
  ));
  

• If you are working with the Rackspace cloud, instantiate an OpenCloud\Rackspace client as follows:

  use OpenCloud\Rackspace;
  
  $client = new Rackspace(Rackspace::US_IDENTITY_ENDPOINT, array(
      'username' => '<YOUR RACKSPACE CLOUD ACCOUNT USERNAME>',
      'apiKey'   => '<YOUR RACKSPACE CLOUD ACCOUNT API KEY>'
  ));
  

Networking service¶

All Networking operations are done via a networking service object. To instantiate this object, call the networkingService method on the $client object. This method takes the following arguments:

$region = '<CLOUD REGION NAME>';
$networkingService = $client->networkingService(null, $region);

Any networks, subnets, and ports created with this $networkingService instance are stored in the cloud region specified by $region.

Create a network¶

This operation takes one parameter, an associative array, with the following keys:

You can create a network as shown in the following example:

$network = $networkingService->createNetwork(array(
    'name' => 'My private backend network'
));
/** @var $network OpenCloud\Networking\Resource\Network **/

[ Get the executable PHP script for this example ]

Create multiple networks¶

This operation takes one parameter, an indexed array. Each element of this array must be an associative array with the keys shown in the preceding table.

You can create multiple networks as shown in the following example:

$networks = $networkingService->createNetworks(array(
    array(
        'name' => 'My private backend network #1'
    ),
    array(
        'name' => 'My private backend network #2'
    )
));

foreach ($networks as $network) {
    /** @var $network OpenCloud\Networking\Resource\Network **/
}

[ Get the executable PHP script for this example ]

List networks¶

You can list all the networks to which you have access as shown in the following example:

$networks = $networkingService->listNetworks();
foreach ($networks as $network) {
    /** @var $network OpenCloud\Networking\Resource\Network **/
}

[ Get the executable PHP script for this example ]

Get a network¶

You can retrieve a specific network by using that network’s ID, as shown in the following example:

$network = $networkingService->getNetwork('eb60583c-57ea-41b9-8d5c-8fab2d22224c');
/** @var $network OpenCloud\Networking\Resource\Network **/

[ Get the executable PHP script for this example ]

Update a network¶

This operation takes one parameter, an associative array, with the following keys:

You can update a network as shown in the following example:

$network->update(array(
    'name' => 'My updated private backend network'
));

[ Get the executable PHP script for this example ]

Delete a network¶

You can delete a network as shown in the following example:

$network->delete();

[ Get the executable PHP script for this example ]

Create a subnet¶

This operation takes one parameter, an associative array, with the following keys:

You can create a subnet as shown in the following example:

$subnet = $networkingService->createSubnet(array(
    'name' => 'My subnet',
    'networkId' => 'eb60583c-57ea-41b9-8d5c-8fab2d22224c',
    'ipVersion' => 4,
    'cidr' => '192.168.199.0/25'
));
/** @var $subnet OpenCloud\Networking\Resource\Subnet **/

[ Get the executable PHP script for this example ]

Create multiple subnets¶

This operation takes one parameter, an indexed array. Each element of this array must be an associative array with the keys shown in the preceding table.

You can create multiple subnets as shown in the following example:

$subnets = $networkingService->createSubnets(array(
    array(
        'name' => 'My subnet #1'
    ),
    array(
        'name' => 'My subnet #2'
    )
));

foreach ($subnets as $subnet) {
    /** @var $subnet OpenCloud\Networking\Resource\Subnet **/
}

[ Get the executable PHP script for this example ]

List subnets¶

You can list all the subnets to which you have access as shown in the following example:

$subnets = $networkingService->listSubnets();
foreach ($subnets as $subnet) {
    /** @var $subnet OpenCloud\Networking\Resource\Subnet **/
}

[ Get the executable PHP script for this example ]

Get a subnet¶

You can retrieve a specific subnet by using that subnet’s ID, as shown in the following example:

$subnet = $networkingService->getSubnet('d3f15879-fb11-49bd-a30b-7704fb98ab1e');
/** @var $subnet OpenCloud\Networking\Resource\Subnet **/

[ Get the executable PHP script for this example ]

Update a subnet¶

This operation takes one parameter, an associative array, with the following keys:

You can update a subnet as shown in the following example:

$subnet->update(array(
    'name' => 'My updated subnet',
    'hostRoutes' => array(
        array(
            'destination' => '1.1.1.0/24',
            'nexthop'     => '192.168.17.19'
        )
    ),
    'gatewayIp' => '192.168.62.155'
));

[ Get the executable PHP script for this example ]

Delete a subnet¶

You can delete a subnet as shown in the following example:

$subnet->delete();

[ Get the executable PHP script for this example ]

Create a port¶

This operation takes one parameter, an associative array, with the following keys:

You can create a port as shown in the following example:

$port = $networkingService->createPort(array(
    'name' => 'My port',
    'networkId' => 'eb60583c-57ea-41b9-8d5c-8fab2d22224c'
));
/** @var $port OpenCloud\Networking\Resource\Port **/

[ Get the executable PHP script for this example ]

Create multiple ports¶

This operation takes one parameter, an indexed array. Each element of this array must be an associative array with the keys shown in the preceding table.

You can create multiple ports as shown in the following example:

$ports = $networkingService->createPorts(array(
    array(
        'name' => 'My port #1',
        'networkId' => 'eb60583c-57ea-41b9-8d5c-8fab2d22224c'
    ),
    array(
        'name' => 'My port #2',
        'networkId' => 'eb60583c-57ea-41b9-8d5c-8fab2d22224c'
    )
));

foreach ($ports as $port) {
    /** @var $port OpenCloud\Networking\Resource\Port **/
}

[ Get the executable PHP script for this example ]

List ports¶

You can list all the ports to which you have access as shown in the following example:

$ports = $networkingService->listPorts();
foreach ($ports as $port) {
    /** @var $port OpenCloud\Networking\Resource\Port **/
}

[ Get the executable PHP script for this example ]

Get a port¶

You can retrieve a specific port by using that port’s ID, as shown in the following example:

$port = $networkingService->getPort('75906d20-6625-11e4-9803-0800200c9a66');
/** @var $port OpenCloud\Networking\Resource\Port **/

[ Get the executable PHP script for this example ]

Update a port¶

This operation takes one parameter, an associative array, with the following keys:

You can update a port as shown in the following example:

$port->update(array(
    'fixedIps' => array(
        array(
            'subnetId'  => '75906d20-6625-11e4-9803-0800200c9a66',
            'ipAddress' => '192.168.199.59'
        )
    )
));

[ Get the executable PHP script for this example ]

Delete a port¶

You can delete a port as shown in the following example:

$port->delete();

[ Get the executable PHP script for this example ]