Chapter 253. OpenStack Neutron Component

Available as of Camel version 2.19

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

253.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.

253.2. URI Format

openstack-neutron://hosturl[?options]

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

253.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:

253.3.1. Path Parameters (1 parameters):

Name	Description	Default	Type
host	Required OpenStack host url		String

253.3.2. Query Parameters (9 parameters):

Name	Description	Default	Type
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

253.4. Spring Boot Auto-Configuration

The component supports 2 options, which are listed below.

Name	Description	Default	Type
camel.component.openstack-neutron.enabled	Enable openstack-neutron component	true	Boolean
camel.component.openstack-neutron.resolve-property-placeholders	Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.	true	Boolean

253.5. Usage

You can use following settings for each subsystem:

253.6. networks

253.6.1. Operations you can perform with the Network producer

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

253.6.2. Message headers evaluated by the Network producer

Header	Type	Description
`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.

253.7. subnets

253.7.1. Operations you can perform with the Subnet producer

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.

253.7.2. Message headers evaluated by the Subnet producer

Header	Type	Description
`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.

253.8. ports

253.8.1. Operations you can perform with the Port producer

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

253.8.2. Message headers evaluated by the Port producer

Header	Type	Description
`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.

253.9. routers

253.9.1. Operations you can perform with the Router producer

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.

253.9.2. Message headers evaluated by the Port producer

Header	Type	Description
`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.

253.10. See Also

Configuring Camel
Component
Endpoint
Getting Started
openstack Component