The ip_pool utility allows managing IP addresses within resellers’ IP pools. With this utility you can perform the following operations:

  • Add/Remove an IP address to/from reseller’s IP pool
  • Set the type of an IP address within a reseller’s IP pool

Usage

ip_pool <command> [<IP address>] [
<option_1> [<param>]
[<option_2> [<param>]]
]

Example

The following command adds the 192.0.2.94 shared IP address to the IP pool of the JDoe reseller account:

plesk bin ip_pool --add 192.0.2.94 -type shared -owner JDoe

Commands

Command Parameter Description Example
--add or -a <IP_address>

Adds an IP address to a reseller’s IP pool.

Requires -owner and -type options.

To add the 192.0.2.34 exclusive IP address to the JDoe IP pool:

plesk bin ip_pool --add 192.0.2.34 -type exclusive -owner JDoe

or

plesk bin ip_pool -a 192.0.2.34 -type exclusive -owner JDoe

--add-list <ip>,<type>[;<ip>,<type>;...]

Adds a number of IP addresses to a reseller’s IP pool.

Requires -owner and -type options.

To add the 192.0.2.34 exclusive IP address and the 192.168.1.2 shared IP address to the JDoe IP pool:

plesk bin ip_pool --add-list 192.0.2.34 -type exclusive 192.168.1.2 -type shared -owner JDoe

--update or -u <IP_address>

Updates IP address properties in a reseller’s IP pool.

Requires -owner and -type options.

To change the type of 192.0.2.34 which belongs to JDoe’s IP pool to shared:

plesk bin ip_pool --update 192.0.2.34 -type shared -owner JDoe

or

plesk bin ip_pool -u 192.0.2.34 -type shared -owner JDoe

--remove or -r <IP_address>

Removes IP address from a reseller’s IP pool.

Requires -owner option.

To remove the 192.0.2.34 IP address from JDoe’s IP pool:

plesk bin ip_pool --remove 192.0.2.34 -owner JDoe

or

plesk bin ip_pool -r 192.0.2.34 -owner JDoe

--help or -h   Displays help on the use of the utility.

To view help on the use of this utility:

plesk bin ip_pool --help

or

plesk bin ip_pool -h

Options

Option Parameter Description Example
-type shared|exclusive Specifies whether an IP address is allocated to a single reseller, or it is shared among many resellers.

To set type of the 192.0.2.34 IP address which belongs to JDoe’s IP pool to shared:

plesk bin ip_pool --update 192.0.2.34 -type shared -owner JDoe

-owner <login>

Specifies owner of the IP pool.

Is required for all commands except for --help.

To remove the 192.0.2.34 IP address from JDoe’s IP pool:

plesk bin ip_pool --remove 192.0.2.34 -owner JDoe