OpenStack Neutron

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.

URI Format

openstack-neutron://hosturl[?options]

Configuring Options

Camel components are configured on two separate levels:

component level
endpoint level

Configuring Component Options

The component level is the highest level which holds general and common configurations that are inherited by the endpoints. For example a component may have security settings, credentials for authentication, urls for network connection and so forth.

Some components only have a few options, and others may have many. Because components typically have pre configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.

Configuring components can be done with the Component DSL, in a configuration file (application.properties|yaml), or directly with Java code.

Configuring Endpoint Options

Where you find yourself configuring the most is on endpoints, as endpoints often have many options, which allows you to configure what you need the endpoint to do. The options are also categorized into whether the endpoint is used as consumer (from) or as a producer (to), or used for both.

Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL and DataFormat DSL as a type safe way of configuring endpoints and data formats in Java.

A good practice when configuring options is to use Property Placeholders, which allows to not hardcode urls, port numbers, sensitive information, and other settings. In other words placeholders allows to externalize the configuration from your code, and gives more flexibility and reuse.

The following two sections lists all the options, firstly for the component followed by the endpoint.

Component Options

The OpenStack Neutron component supports 2 options, which are listed below.

Name	Description	Default	Type
lazyStartProducer (producer)	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	boolean
autowiredEnabled (advanced)	Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.	true	boolean

Name

Description

Default

Type

lazyStartProducer (producer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

boolean

autowiredEnabled (advanced)

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

boolean

Endpoint Options

The OpenStack Neutron endpoint is configured using URI syntax:

openstack-neutron:host

with the following path and query parameters:

Path Parameters (1 parameters)

Name	Description	Default	Type
host (producer)	Required OpenStack host url.		String

Name

Description

Default

Type

host (producer)

Required OpenStack host url.

String

Query Parameters (9 parameters)

Name	Description	Default	Type
apiVersion (producer)	OpenStack API version. Enum values: V2 V3	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. Enum values: networks subnets ports routers		String
username (producer)	Required OpenStack username.		String
lazyStartProducer (producer (advanced))	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	boolean

Name

Description

Default

Type

apiVersion (producer)

OpenStack API version.

Enum values:

V2
V3

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.

Enum values:

networks
subnets
ports
routers

String

username (producer)

Required OpenStack username.

String

lazyStartProducer (producer (advanced))

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

boolean

Message Headers

The OpenStack Neutron component supports 22 message header(s), which is/are listed below:

Name Description Default Type

Name	Description	Type
tenantId (network port router) Constant: `TENANT_ID`	Tenant ID.	String
networkId (subnet port) Constant: `NETWORK_ID`	Network ID.	String
adminStateUp (network) Constant: `ADMIN_STATE_UP`	AdminStateUp header.	Boolean
networkType (network) Constant: `NETWORK_TYPE`	Network type. Enum values: LOCAL FLAT VLAN VXLAN GRE	NetworkType
physicalNetwork (network) Constant: `PHYSICAL_NETWORK`	Physical network.	String
segmentId (network) Constant: `SEGMENT_ID`	Segment ID.	String
isShared (network) Constant: `IS_SHARED`	Is shared.	Boolean
isRouterExternal (network) Constant: `IS_ROUTER_EXTERNAL`	Is router external.	Boolean
enableDHCP (subnet) Constant: `ENABLE_DHCP`	Enable DHCP.	Boolean
gateway (subnet) Constant: `GATEWAY`	Gateway.	String
ipVersion (subnet) Constant: `IP_VERSION`	IP version. Enum values: V4 V6	IPVersionType
cidr (subnet) Constant: `CIDR`	The cidr representing the IP range for this subnet, based on IP version.	String
subnetPools (subnet) Constant: `SUBNET_POOL`	The allocation pool.	NeutronPool
deviceId (port) Constant: `DEVICE_ID`	Device ID.	String
macAddress (port) Constant: `MAC_ADDRESS`	MAC address.	String
routerId (router) Constant: `ROUTER_ID`	Router ID.	String
subnetId (router subnet) Constant: `SUBNET_ID`	Subnet ID.	String
portId (port router) Constant: `PORT_ID`	Port ID.	String
interfaceType (router) Constant: `ITERFACE_TYPE`	Interface type. Enum values: PORT SUBNET	AttachInterfaceType
operation (producer) Constant: `OPERATION`	The operation to perform.	String
ID (producer) Constant: `ID`	The ID.	String
name (producer) Constant: `NAME`	The name.	String

tenantId (network port router)

Constant: TENANT_ID

Tenant ID.

String

networkId (subnet port)

Constant: NETWORK_ID

Network ID.

String

adminStateUp (network)

Constant: ADMIN_STATE_UP

AdminStateUp header.

Boolean

networkType (network)

Constant: NETWORK_TYPE

Network type.

Enum values:

LOCAL
FLAT
VLAN
VXLAN
GRE

NetworkType

physicalNetwork (network)

Constant: PHYSICAL_NETWORK

Physical network.

String

segmentId (network)

Constant: SEGMENT_ID

Segment ID.

String

isShared (network)

Constant: IS_SHARED

Is shared.

Boolean

isRouterExternal (network)

Constant: IS_ROUTER_EXTERNAL

Is router external.

Boolean

enableDHCP (subnet)

Constant: ENABLE_DHCP

Enable DHCP.

Boolean

gateway (subnet)

Constant: GATEWAY

Gateway.

String

ipVersion (subnet)

Constant: IP_VERSION

IP version.

Enum values:

V4
V6

IPVersionType

cidr (subnet)

Constant: CIDR

The cidr representing the IP range for this subnet, based on IP version.

String

subnetPools (subnet)

Constant: SUBNET_POOL

The allocation pool.

NeutronPool

deviceId (port)

Constant: DEVICE_ID

Device ID.

String

macAddress (port)

Constant: MAC_ADDRESS

MAC address.

String

routerId (router)

Constant: ROUTER_ID

Router ID.

String

subnetId (router subnet)

Constant: SUBNET_ID

Subnet ID.

String

portId (port router)

Constant: PORT_ID

Port ID.

String

interfaceType (router)

Constant: ITERFACE_TYPE

Interface type.

Enum values:

PORT
SUBNET

AttachInterfaceType

operation (producer)

Constant: OPERATION

The operation to perform.

String

ID (producer)

Constant: ID

The ID.

String

name (producer)

Constant: NAME

The name.

String

Usage

You can use following settings for each subsystem:

networks

Operations you can perform with the Network producer

Operation Description

Operation	Description
`create`	Create new network.
`get`	Get the network.
`getAll`	Get all networks.
`delete`	Delete the network.

create

Create new network.

get

Get the network.

getAll

Get all networks.

delete

Delete the network.

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.

subnets

Operations you can perform with the Subnet producer

Operation Description

Operation	Description
`create`	Create new subnet.
`get`	Get the subnet.
`getAll`	Get all subnets.
`delete`	Delete the subnet.
`action`	Perform an action on the subnet.

create

Create new subnet.

get

Get the subnet.

getAll

Get all subnets.

delete

Delete the subnet.

action

Perform an action on the subnet.

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.

ports

Operations you can perform with the Port producer

Operation Description

Operation	Description
`create`	Create new port.
`get`	Get the port.
`getAll`	Get all ports.
`update`	Update the port.
`delete`	Delete the port.

create

Create new port.

get

Get the port.

getAll

Get all ports.

update

Update the port.

delete

Delete the port.

routers

Operations you can perform with the Router producer

Operation Description

Operation	Description
`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.

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.

Spring Boot Auto-Configuration

When using openstack-neutron with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

<dependency>
  <groupId>org.apache.camel.springboot</groupId>
  <artifactId>camel-openstack-starter</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>

The component supports 18 options, which are listed below.

Name	Description	Default	Type
camel.component.openstack-cinder.autowired-enabled	Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.	true	Boolean
camel.component.openstack-cinder.enabled	Whether to enable auto configuration of the openstack-cinder component. This is enabled by default.		Boolean
camel.component.openstack-cinder.lazy-start-producer	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	Boolean
camel.component.openstack-glance.autowired-enabled	Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.	true	Boolean
camel.component.openstack-glance.enabled	Whether to enable auto configuration of the openstack-glance component. This is enabled by default.		Boolean
camel.component.openstack-glance.lazy-start-producer	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	Boolean
camel.component.openstack-keystone.autowired-enabled	Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.	true	Boolean
camel.component.openstack-keystone.enabled	Whether to enable auto configuration of the openstack-keystone component. This is enabled by default.		Boolean
camel.component.openstack-keystone.lazy-start-producer	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	Boolean
camel.component.openstack-neutron.autowired-enabled	Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.	true	Boolean
camel.component.openstack-neutron.enabled	Whether to enable auto configuration of the openstack-neutron component. This is enabled by default.		Boolean
camel.component.openstack-neutron.lazy-start-producer	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	Boolean
camel.component.openstack-nova.autowired-enabled	Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.	true	Boolean
camel.component.openstack-nova.enabled	Whether to enable auto configuration of the openstack-nova component. This is enabled by default.		Boolean
camel.component.openstack-nova.lazy-start-producer	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	Boolean
camel.component.openstack-swift.autowired-enabled	Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.	true	Boolean
camel.component.openstack-swift.enabled	Whether to enable auto configuration of the openstack-swift component. This is enabled by default.		Boolean
camel.component.openstack-swift.lazy-start-producer	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	Boolean

Name

Description

Default

Type

camel.component.openstack-cinder.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

camel.component.openstack-cinder.enabled

Whether to enable auto configuration of the openstack-cinder component. This is enabled by default.

Boolean

camel.component.openstack-cinder.lazy-start-producer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

Boolean

camel.component.openstack-glance.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

camel.component.openstack-glance.enabled

Whether to enable auto configuration of the openstack-glance component. This is enabled by default.

Boolean

camel.component.openstack-glance.lazy-start-producer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

Boolean

camel.component.openstack-keystone.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

camel.component.openstack-keystone.enabled

Whether to enable auto configuration of the openstack-keystone component. This is enabled by default.

Boolean

camel.component.openstack-keystone.lazy-start-producer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

Boolean

camel.component.openstack-neutron.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

camel.component.openstack-neutron.enabled

Whether to enable auto configuration of the openstack-neutron component. This is enabled by default.

Boolean

camel.component.openstack-neutron.lazy-start-producer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

Boolean

camel.component.openstack-nova.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

camel.component.openstack-nova.enabled

Whether to enable auto configuration of the openstack-nova component. This is enabled by default.

Boolean

camel.component.openstack-nova.lazy-start-producer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

Boolean

camel.component.openstack-swift.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

camel.component.openstack-swift.enabled

Whether to enable auto configuration of the openstack-swift component. This is enabled by default.

Boolean

camel.component.openstack-swift.lazy-start-producer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

Boolean