ip_pool.exe: IP Pools

The ip_pool.exe utility allows managing IP addresses within resellers' IP pools. With this utility you can add\remove IP addresses to\from reseller's IP pool, and set the IP address type.

Location

%plesk_cli%

 

Usage
ip_pool.exe <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:

ip_pool.exe --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:

ip_pool.exe --add 192.0.2.34 -type exclusive -owner JDoe

or

ip_pool.exe --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:

ip_pool.exe --add-list 192.0.2.34 -type exclusive 192.168.1.2 -type shared -owner JDoe

--update or -u

<IP_address>

Updates IP address info in a reseller's IP pool.

Requires -owner and -type options.

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

ip_pool.exe --update 192.0.2.34 -type shared -owner JDoe

or

ip_pool.exe -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 the JDoe's IP pool:

ip_pool.exe --remove 192.0.2.34 -owner JDoe

or

ip_pool.exe -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:

ip_pool.exe --help

or

ip_pool.exe -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 the JDoe's IP pool to shared:

>ip_pool --update 192.0.2.34 -type shared -owner JDoe

-owner

<login_name>

Specifies owner of the IP pool.

Is required for all commands except for --help.

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

>ip_pool --remove 192.0.2.34 -owner JDoe

 

 

Leave your comments on this page

Leave your feedback or question on this documentation topic below. For technical assistance, contact your hosting service provider or submit a request to Plesk support. Suggest new features for Plesk here. Discuss general questions on the Plesk forum. All offtopic comments will be removed.