ipmanage: IP Addresses

The ipmanage utility is used to manage IP addresses in Plesk. By using this utility, you can perform the following tasks:

  • creating and removing IP addresses
  • setting IP address type (exclusive or shared), subnet mask, and network interface
  • assigning SSL certificates
  • viewing the list of available IP addresses, SSL certificates, and network interfaces

Usage
ipmanage <command> [<IP address>] [
<option_1> [<param>]
[<option_2> [<param>]]
... [<option_N> [<param>]]
]

Example

The following command creates IP address 192.0.2.78 with subnet mask 255.255.255.0, specifies physical network interface named Local Area Connection for the IP address, sets the type of the IP address to exclusive, and specifies the name of the SSL certificate (My site certificate) to be used for the IP address.

plesk bin ipmanage --create 192.0.2.78 -mask 255.255.255.0 -interface "eth0" -type exclusive -ssl_certificate "My site certificate"

Commands
Command Parameter Description Example

--create or -c

<IP_address>

Creates an IP address.

Requires the -type, -interface, and -mask options.

To create IP address 192.0.2.78, set its type to shared, network mask to 255.255.0.0, and physical network interface to Local Area Connection:

plesk bin ipmanage --create 192.0.2.78 -type shared -mask 255.255.0.0 -interface "eth0"

or

plesk bin ipmanage -c 192.0.2.78 -type shared -mask 255.255.0.0 -interface "eth0"

--update or -u

<IP_address>

Updates various parameters of an IP address such as its type, subnet mask, network interface, and associated SSL certificates.

To change the type of IP address 192.0.2.78 from shared to exclusive:

plesk bin ipmanage --update 192.0.2.78 -type exclusive

or

plesk bin ipmanage -u 192.0.2.78 -type exclusive

--remove or -r

<IP_address>

Deletes an IP address.

To remove IP address 192.0.2.78:

plesk bin ipmanage --remove 192.0.2.78

or

plesk bin ipmanage -r 192.0.2.78

--reread

 

Rereads the IP addresses.

To reread the IP addresses:

plesk bin ipmanage --reread

--ip_list or -l

 

Displays the list of available IP addresses.

To view the list of available IP addresses:

plesk bin ipmanage --ip_list

or

plesk bin ipmanage -l

--ssl_list or -s

 

Displays the list of available SSL certificates.

To view the list of available SSL certificates:

plesk bin ipmanage --ssl_list

or

plesk bin ipmanage -s

--inter_list or -f

 

Displays the list of available interfaces.

To view the list of available network interfaces:

plesk bin ipmanage --inter_list

or

plesk bin ipmanage -f

--xml-info or -xi

 

Displays information about all available IP address in the XML format.

To view information about all available IP addresses in the XML format:

plesk bin ipmanage --xml-info

or

plesk bin ipmanage -xi

--reset_ssl_certificate

 

Specifies a default SSL certificate to all available IP addresses.

To set default SSL certificate to all available IP addresses:

plesk bin ipmanage --reset_ssl_certificate

--auto-remap-ip-addresses

true|false

Defines whether to perform the automatic mapping of IP addresses on Plesk startup. Use the option in cases when the registered IP addresses are changed (for example, when cloning a VPS with Plesk).

To enable automatic mapping of IP addresses on Plesk startup:

plesk bin ipmanage --auto-remap-ip-addresses

--help or -h

 

Displays help on the use of the utility.

To view help on the use of the ipmanage utility:

plesk bin ipmanage --help

or

plesk bin ipmanage -h

Options
Option Parameter Description Example

-type

shared|exclusive

Specifies the type of an IP address.

Required with the --create.

To change the type of IP address 192.0.2.78 from shared to exclusive:

plesk bin ipmanage -u 192.0.2.78 -type exclusive

-ssl_certificate

<name>

Specifies the name of an SSL certificate to be used for the IP address.

To assign SSL certificate named New Certificate to IP address 192.0.2.78:

plesk bin ipmanage -u 192.0.2.78 -ssl_certificate "New Certificate"

-public_ip

<IP>

Maps an internal IP to a public one to create NAT. Used with the --create and --update commands.

To map an internal IP 192.168.1.2 to a public IP 92.68.1.2:

plesk bin ipmanage -u # ./plesk bin ipmanage -u -public_ip 92.68.1.2

-mask

<x.x.x.x|nn>

Specifies the subnet mask for an IP address.

Required with the --create.

Used with the --create only.

To create IP address 192.0.2.78, set its type to shared, network mask to 16, and physical network interface to Local Area Connection:

plesk bin ipmanage -c 192.0.2.78 -type shared -mask 16 -interface "eth0"

-interface

<device>

Specifies the name of the physical network interface for an IP address.

Required with the --create.

Used with the --create only.

 

 

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.