Chapter 241. OpenStack Neutron Component

Available as of Camel version 2.19

The openstack-neutron component allows messages to be sent to an OpenStack network services.

241.1. Dependencies

Maven users will need to add the following dependency to their pom.xml.

pom.xml

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-openstack</artifactId>
    <version>${camel-version}</version>
</dependency>

where ${camel-version} must be replaced by the actual version of Camel.

241.2. URI Format

openstack-neutron://hosturl[?options]

You can append query options to the URI in the following format ?options=value&option2=value&…​

241.3. URI Options

The OpenStack Neutron component has no options.

The OpenStack Neutron endpoint is configured using URI syntax:

openstack-neutron:host

with the following path and query parameters:

241.3.1. Path Parameters (1 parameters):

NameDescriptionDefaultType

host

Required OpenStack host url

 

String

241.3.2. Query Parameters (9 parameters):

NameDescriptionDefaultType

apiVersion (producer)

OpenStack API version

V3

String

config (producer)

OpenStack configuration

 

Config

domain (producer)

Authentication domain

default

String

operation (producer)

The operation to do

 

String

password (producer)

Required OpenStack password

 

String

project (producer)

Required The project ID

 

String

subsystem (producer)

Required OpenStack Neutron subsystem

 

String

username (producer)

Required OpenStack username

 

String

synchronous (advanced)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

boolean

241.4. Usage

You can use following settings for each subsystem:

241.5. networks

241.5.1. Operations you can perform with the Network producer

OperationDescription

create

Create new network.

get

Get the network.

getAll

Get all networks.

delete

Delete the network.

241.5.2. Message headers evaluated by the Network producer

HeaderTypeDescription

operation

String

The operation to perform.

ID

String

ID of the network.

name

String

The network name.

tenantId

String

Tenant ID.

adminStateUp

Boolean

AdminStateUp header.

networkType

org.openstack4j.model.network.NetworkType

Network type.

physicalNetwork

String

Physical network.

segmentId

String

Segment ID.

isShared

Boolean

Is shared.

isRouterExternal

Boolean

Is router external.

If you need more precise network settings you can create new object of the type org.openstack4j.model.network.Network and send in the message body.

241.6. subnets

241.6.1. Operations you can perform with the Subnet producer

OperationDescription

create

Create new subnet.

get

Get the subnet.

getAll

Get all subnets.

delete

Delete the subnet.

action

Perform an action on the subnet.

241.6.2. Message headers evaluated by the Subnet producer

HeaderTypeDescription

operation

String

The operation to perform.

ID

String

ID of the subnet.

name

String

The subnet name.

networkId

String

Network ID.

enableDHCP

Boolean

Enable DHCP.

gateway

String

Gateway.

If you need more precise subnet settings you can create new object of the type org.openstack4j.model.network.Subnet and send in the message body.

241.7. ports

241.7.1. Operations you can perform with the Port producer

OperationDescription

create

Create new port.

get

Get the port.

getAll

Get all ports.

update

Update the port.

delete

Delete the port.

241.7.2. Message headers evaluated by the Port producer

HeaderTypeDescription

operation

String

The operation to perform.

name

String

The port name.

networkId

String

Network ID.

tenantId

String

Tenant ID.

deviceId

String

Device ID.

macAddress

String

MAC address.

241.8. routers

241.8.1. Operations you can perform with the Router producer

OperationDescription

create

Create new router.

get

Get the router.

getAll

Get all routers.

update

Update the router.

delete

Delete the router.

attachInterface

Attach an interface.

detachInterface

Detach an interface.

241.8.2. Message headers evaluated by the Port producer

HeaderTypeDescription

operation

String

The operation to perform.

name

String

The router name.

routerId

String

Router ID.

subnetId

String

Subnet ID.

portId

String

Port ID.

interfaceType

org.openstack4j.model.network.AttachInterfaceType

Interface type.

tenantId

String

Tenant ID.

241.9. See Also

  • Configuring Camel
  • Component
  • Endpoint
  • Getting Started
  • openstack Component