Changes between Version 3 and Version 4 of i2pcontrol


Ignore:
Timestamp:
Jan 25, 2016 3:16:04 PM (3 years ago)
Author:
tuna
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • i2pcontrol

    v3 v4  
    5353   * '''''parameter''''' [type of parameter]:  [null], [nubmer], [string], [boolean], [array] or [object]. [object] being a {key:value} map.
    5454{{{
    55 [string]
    56 "return_value" // This is the value returned by the RPC call
     55"return_value" [string] // This is the value returned by the RPC call
    5756}}}
    5857
     
    7069}}}
    7170
    72 
    73  * '''stats.''' - This group of methods provide access to all stats kept within the instance.
     71 * '''i2pcontrol.''' - Configure i2pcontrol
     72   * '''i2pcontrol.address''' - Get/Set the ip address that i2pcontrol listens to.
     73     * '''''get''''' [null]: This parameter does not need to be set.
     74{{{
     75"0.0.0.0" [string]
     76}}}
     77     * '''''set''''' [string]: This will be an ip address like "0.0.0.0" or "192.168.0.1"
     78{{{
     79[nil]
     80}}}
     81   * '''i2pcontrol.password''' - Change the i2pcontrol password.
     82     * '''''set''''' [string]: Set the new password to this string
     83{{{
     84[nil]
     85}}}
     86   * '''i2pcontrol.port''' - Get/Set the port that i2pcontrol listens to.
     87     * '''''get''''' [null]: This parameter does not need to be set.
     88{{{
     897650 [number]
     90}}}
     91     * '''''set''''' [number]: Change the port that i2pcontrol listens to to this port
     92{{{
     93[nil]
     94}}}
     95
     96 * '''settings.''' - Get/Set i2p instance settings
     97   * '''settings.ntcp.port''' - NTCP port
     98     * '''''get''''' [null]: This parameter does not need to be set.
     99{{{
     1000 [number]
     101}}}
     102     * '''''set''''' [number]: Set new NTCP port.
     103{{{
     104[nil]
     105}}}
     106   * '''settings.ntcp.hostname''' - Get NTCP hostname
     107     * '''''get''''' [null]: This parameter does not need to be set.
     108{{{
     109"0.0.0.0" [string]
     110}}}
     111     * '''''set''''' [string]: Set new hostname
     112{{{
     113[nil]
     114}}}
     115   * '''settings.ntcp.autoip''' - Get IP auto detection setting for NTCP
     116     * '''''get''''' [null]: This parameter does not need to be set.
     117{{{
     118true [boolean]
     119}}}
     120     * '''''set''''' [boolean]: Set NTCP IP auto detection
     121{{{
     122[nil]
     123}}}
     124   * '''settings.ssu.port''' - SSU port
     125     * '''''get''''' [null]: This parameter does not need to be set.
     126{{{
     1270 [number]
     128}}}
     129     * '''''set''''' [number]: Set new SSU port.
     130{{{
     131[nil]
     132}}}
     133   * '''settings.ssu.hostname''' - Get SSU hostname
     134     * '''''get''''' [null]: This parameter does not need to be set.
     135{{{
     136"0.0.0.0" [string]
     137}}}
     138     * '''''set''''' [string]: Set new SSU hostname
     139{{{
     140[nil]
     141}}}
     142   * '''settings.ssu.autoip''' - Get IP auto detection setting for SSU
     143     * '''''get''''' [nil]: This parameter does not need to be set.
     144{{{
     145true [boolean]
     146}}}
     147     * '''''set''''' [boolean]: Set SSU IP auto detection
     148{{{
     149[nil]
     150}}}
     151   * '''settings.upnp''' - Enable or disable UPNP
     152     * '''''get''''' [nil]: This parameter does not need to be set.
     153{{{
     154true [boolean]
     155}}}
     156     * '''''set''''' [boolean]: Set SSU IP auto detection
     157{{{
     158[nil]
     159}}}
     160   * '''settings.bandwidth.in''' - Inbound bandwidth settings
     161   * '''settings.bandwidth.out''' - Outbound bandwidth settings
     162     * '''''get''''' [nil]: This parameter does not need to be set.
     163{{{
     1640 [number]
     165}}}
     166     * '''''set''''' [number]: Set the bandwidth limit
     167{{{
     168[nil]
     169}}}
     170
     171
     172
     173 * '''stats.''' - Get stats from the i2p instance
    74174   * '''stats.advanced''' - This method provides access to all stats kept within the instance.
    75175     * '''''get''''' [string]:  Name of the advanced stat to be provided
     
    84184   * '''stats.netdb.peers.highcapacity''' - Returns the number of 'high capacity' peers
    85185   * '''stats.netdb.peers.known''' - Returns the number of known peers
    86      * ''''' '''''' [nil]: No parameter is needed
    87 {{{
    88 [number]
    89 0.0
    90 }}}
    91 
    92  * '''stats.????''' - Given that a correct password is provided, this method provides you with a token for further access and a list of supported API levels.
    93    * '''''get''''' [null]: This parameter does not need to be set.
    94 {{{
    95 [number]
    96 0.0
    97 }}}
    98 
    99 
    100  * '''i2pcontrol.address''' - Get/Set the ip address that i2pcontrol listens to.
    101    * '''''get''''' [nil]: This parameter does not need to be set.
    102 {{{
    103 [string]
    104 "0.0.0.0"
    105 }}}
    106    * '''''set''''' [string]: This will be an ip address like "0.0.0.0" or "192.168.0.1"
    107 {{{
    108 [nil]
    109 }}}
    110 
    111  * '''i2pcontrol.password''' - Change the i2pcontrol password.
    112    * '''''set''''' [string]: Set the new password to this string
    113 {{{
    114 [nil]
    115 }}}
    116 
    117  * '''i2pcontrol.port''' - Get/Set the port that i2pcontrol listens to.
    118    * '''''get''''' [nil]: This parameter does not need to be set.
    119 {{{
    120 [number]
    121 7650
    122 }}}
    123    * '''''set''''' [number]: Change the port that i2pcontrol listens to to this port
    124 {{{
    125 [nil]
    126 }}}
    127 
    128 
    129 
    130 *i2p.router.status - Returns the number of known peers
    131 *i2p.router.net.status – [long] What the current network status is. According to the below enum:
    132     0 – OK
    133     1 – TESTING
    134     2 – FIREWALLED
    135     3 – HIDDEN
    136     4 – WARN_FIREWALLED_AND_FAST
    137     5 – WARN_FIREWALLED_AND_FLOODFILL
    138     6 – WARN_FIREWALLED_WITH_INBOUND_TCP
    139     7 – WARN_FIREWALLED_WITH_UDP_DISABLED
    140     8 – ERROR_I2CP
    141     9 – ERROR_CLOCK_SKEW
    142     10 – ERROR_PRIVATE_TCP_ADDRESS
    143     11 – ERROR_SYMMETRIC_NAT
    144     12 – ERROR_UDP_PORT_IN_USE
    145     13 – ERROR_NO_ACTIVE_PEERS_CHECK_CONNECTION_AND_FIREWALL
    146     14 – ERROR_UDP_DISABLED_AND_TCP_UNSET
    147 *i2p.router.netdb.isreseeding – [boolean] Is the router reseeding hosts to its NetDB?
     186     * '''''get''''' [null]: This parameter does not need to be set.
     187{{{
     1880.0 [number]
     189}}}
     190
     191
     192
     193 * '''status.''' - Get i2p instance status
     194   * '''status.router''' - Get router status
     195     * '''''get''''' [null]: This parameter does not need to be set.
     196{{{
     197"status" [string]
     198}}}
     199   * '''status.net''' - Get router network status
     200     * '''''get''''' [null]: This parameter does not need to be set.
     201{{{
     2020 [number]
     203/**
     204 *    0 – OK
     205 *    1 – TESTING
     206 *    2 – FIREWALLED
     207 *    3 – HIDDEN
     208 *    4 – WARN_FIREWALLED_AND_FAST
     209 *    5 – WARN_FIREWALLED_AND_FLOODFILL
     210 *    6 – WARN_FIREWALLED_WITH_INBOUND_TCP
     211 *    7 – WARN_FIREWALLED_WITH_UDP_DISABLED
     212 *    8 – ERROR_I2CP
     213 *    9 – ERROR_CLOCK_SKEW
     214 *   10 – ERROR_PRIVATE_TCP_ADDRESS
     215 *   11 – ERROR_SYMMETRIC_NAT
     216 *   12 – ERROR_UDP_PORT_IN_USE
     217 *   13 – ERROR_NO_ACTIVE_PEERS_CHECK_CONNECTION_AND_FIREWALL
     218 *   14 – ERROR_UDP_DISABLED_AND_TCP_UNSET
     219 */
     220}}}
     221   * '''status.isfloodfill''' - Is the i2p instance currently a floodfill
     222     * '''''get''''' [null]: This parameter does not need to be set.
     223{{{
     224true [boolean]
     225}}}
     226   * '''status.isreseeding''' - Is the i2p instance currently reseeding
     227     * '''''get''''' [null]: This parameter does not need to be set.
     228{{{
     229true [boolean]
     230}}}
     231   * '''status.ip''' - Public IP detected of this i2p instance
     232     * '''''get''''' [null]: This parameter does not need to be set.
     233{{{
     234"0.0.0.0" [string]
     235}}}