Interface GlobalVlanApi


  • public interface GlobalVlanApi
    Provides synchronous access to cloudstack via their REST API.

    See Also:
    • Method Detail

      • getVlanIPRange

        @Named("listVlanIpRanges")
        @GET
        @Consumes("application/json")
        VlanIPRange getVlanIPRange​(@QueryParam("id")
                                   String id)
        Get the details of an IP range by its id.
        Parameters:
        id - the required IP range.
        Returns:
        the requested IP range.
      • listVlanIPRanges

        @Named("listVlanIpRanges")
        @GET
        @Consumes("application/json")
        Set<VlanIPRange> listVlanIPRanges​(ListVlanIPRangesOptions... options)
        Lists all VLAN IP ranges.
        Parameters:
        options - optional arguments.
        Returns:
        the list of IP ranges that match the criteria.
      • createVlanIPRange

        @Named("createVlanIpRange")
        @GET
        @Consumes("application/json")
        VlanIPRange createVlanIPRange​(@QueryParam("startip")
                                      String startIP,
                                      @QueryParam("endip")
                                      String endIP,
                                      CreateVlanIPRangeOptions... options)
        Creates a VLAN IP range.
        Parameters:
        startIP - the beginning IP address in the VLAN IP range
        endIP - the ending IP address in the VLAN IP range
        options - optional arguments
        Returns:
        the newly-create IP range.
      • deleteVlanIPRange

        @Named("deleteVlanIpRange")
        @GET
        @Consumes("application/json")
        void deleteVlanIPRange​(@QueryParam("id")
                               String rangeId)
        Deletes a VLAN IP range.
        Parameters:
        rangeId - the id of the VLAN IP range