org.openstack4j.api.networking.ext

Interface AgentService

All Superinterfaces:

RestService

All Known Implementing Classes:

AgentServiceImpl

public interface AgentService
extends RestService

Networking (Neutron) Agent Extension API

Author:

Yin Zhang

Method Summary

Modifier and Type	Method and Description
ActionResponse	attachNetworkToDhcpAgent(String agentId, String networkId) Schedules the network to that the specified DHCP agent.
ActionResponse	detachNetworkToDhcpAgent(String agentId, String networkId) Removes the network from that the specified DHCP agent.
Agent	getAgent(String agentId) Returns the agent with agentId.
List<? extends Agent>	list() List neutron agents.
Agent	setAdminStateUp(String agentId, boolean state) Sets the admin_state_up.

Method Detail

list

List<? extends Agent> list()

List neutron agents.

Returns:

a list of available neutron agents

getAgent

Agent getAgent(String agentId)

Returns the agent with agentId.

Parameters:

agentId - id of agent

Returns:

agent

setAdminStateUp

Agent setAdminStateUp(String agentId,
                      boolean state)

Sets the admin_state_up.

Parameters:

agentId - the id of the agent to set state for

state - the state to set

Returns:

a new reference to the updated agent

attachNetworkToDhcpAgent

ActionResponse attachNetworkToDhcpAgent(String agentId,
                                        String networkId)

Schedules the network to that the specified DHCP agent.

Parameters:

agentId - the id of agent with type DHCP

networkId - the id of network

Returns:

the action response

detachNetworkToDhcpAgent

ActionResponse detachNetworkToDhcpAgent(String agentId,
                                        String networkId)

Removes the network from that the specified DHCP agent.

Parameters:

agentId - the id of agent with type DHCP

networkId - the id of network

Returns:

the action response