Method Detail

• listNetworks

  @Named(value="networks:list")
  @GET
  List<Network> listNetworks()

  Returns:

  a set of networks

• createNetwork

  @Named(value="network:create")
  @POST
  @Path(value="/create")
  Network createNetwork(Network network)

  Parameters:

  network - the network’s configuration (@see BindToJsonPayload)

  Returns:

  a new network

• inspectNetwork

  @Named(value="network:inspect")
  @GET
  @Path(value="/{idOrName}")
  Network inspectNetwork(@PathParam(value="idOrName")
                                      String networkIdOrName)

  Return low-level information on the network id

  Parameters:

  networkIdOrName - The id or name of the network to get.

  Returns:

  The details of the network or null if the network with the given id doesn't exist.

• removeNetwork

  @Named(value="network:delete")
  @DELETE
  @Path(value="/{idOrName}")
  void removeNetwork(@PathParam(value="idOrName")
                                     String networkIdOrName)

  Parameters:

  networkIdOrName - The id or name of the network to be removed.

• connectContainerToNetwork

  @Named(value="network:connectContainer")
  @POST
  @Path(value="/{idOrName}/connect")
  void connectContainerToNetwork(@PathParam(value="idOrName")
                                               String networkIdOrName,
                                               String containerIdOrName)

  Parameters:

  networkIdOrName - The id or name of the network where the container will be attached.

• disconnectContainerFromNetwork

  @Named(value="network:disconnectContainer")
  @POST
  @Path(value="/{idOrName}/disconnect")
  void disconnectContainerFromNetwork(@PathParam(value="idOrName")
                                                    String networkIdOrName,
                                                    String containerIdOrName)

  Parameters:

  networkIdOrName - The id or name of the network where the container was attached.