| = OpenStack Neutron Component |
| :doctitle: OpenStack Neutron |
| :shortname: openstack-neutron |
| :artifactid: camel-openstack |
| :description: Access OpenStack Neutron for network services. |
| :since: 2.19 |
| :supportlevel: Stable |
| :tabs-sync-option: |
| :component-header: Only producer is supported |
| //Manually maintained attributes |
| :group: OpenStack |
| :camel-spring-boot-name: openstack |
| |
| *Since Camel {since}* |
| |
| *{component-header}* |
| |
| The Openstack Neutron component allows messages to be sent to an OpenStack network services. |
| |
| == Dependencies |
| |
| Maven users will need to add the following dependency to their `pom.xml`. |
| |
| .pom.xml |
| [source,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] |
| ---------------------------- |
| |
| |
| // component options: START |
| include::partial$component-configure-options.adoc[] |
| include::partial$component-endpoint-options.adoc[] |
| include::partial$component-endpoint-headers.adoc[] |
| // component options: END |
| |
| |
| == Usage |
| |
| You can use the following settings for each subsystem: |
| |
| === Networks |
| |
| ==== Operations you can perform with the Network producer |
| [width="100%",cols="20%,80%",options="header",] |
| |========================================================================= |
| |Operation | Description |
| |
| |`create` | Create a new network. |
| |
| |`get` | Get the network. |
| |
| |`getAll` | Get all networks. |
| |
| |`delete` | Delete the network. |
| |========================================================================= |
| |
| If you need more precise network settings, you can create a 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 |
| [width="100%",cols="20%,80%",options="header",] |
| |========================================================================= |
| |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. |
| |========================================================================= |
| |
| If you need more precise subnet settings, you can create a 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 |
| [width="100%",cols="20%,80%",options="header",] |
| |========================================================================= |
| |Operation | Description |
| |
| |`create` | Create a 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 |
| [width="100%",cols="20%,80%",options="header",] |
| |========================================================================= |
| |Operation | Description |
| |
| |`create` | Create a 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. |
| |
| |========================================================================= |
| |
| include::spring-boot:partial$starter.adoc[] |
