Package io.github.jnodorp.jiffybox.modules

Schnittstelle ModuleIps

public interface ModuleIps
This interface describes the ips module.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    Response<IPSet>
    getIPSet(int id)
    Lists all IP addresses of a single JiffyBox.
    Response<Map<String,IPSet>>
    getIPSets()
    To display every IP address of each JiffyBox you can use this command.
    Response<Boolean>
    moveIPAddress(int boxid, int ipid, int targetid)
    Using this command you can move IPv4 addresses between JiffyBoxes.

  • Methodendetails

    • getIPSets

      Response<Map<String,IPSet>> getIPSets()
      To display every IP address of each JiffyBox you can use this command. The result isSubnet says whether it is an IP address or a subnet. IPv6 subnets can be created using the control panel. The value reverseLookup provides the IPs reverse DNS name. For subnets the DNS lookup can optionally be delegated to a foreign name server. The result value type private provides information whether the IP address is public or private (non-routable). The value floating says if it is possible to move the address between JiffyBoxes, e. g. to implement a failover mechanism. Moving addresses is only possible for IPv4 addresses ordered additionally via the control panel.
      Gibt zurück:
      All IP sets by JiffyBox.

    • getIPSet

      Response<IPSet> getIPSet(int id)
      Lists all IP addresses of a single JiffyBox.
      Parameter:
      id - Box-ID
      Gibt zurück:
      The IP set of a specific JiffyBox.

    • moveIPAddress

      Response<Boolean> moveIPAddress(int boxid, int ipid, int targetid)
      Using this command you can move IPv4 addresses between JiffyBoxes. This is only possible for IPv4 addresses ordered additionally via the control. The command influences solely the routing within the JiffyBox network. To be able to use the on the targeted JiffyBox it has to be configured within the targeted Linux normally.
      Parameter:
      boxid - Box-ID
      ipid - IP-ID
      targetid - The targeted JiffyBox to which the IP address should be allocated.
      Gibt zurück:
      If the moving of the IP address was successful.