# ipmanage.exe: IP Addresses

The `ipmanage.exe` utility serves to manage Plesk IP addresses. This utility allows the following:

- registering IP addresses in Plesk database
- removing IP addresses from Plesk database
- assigning an SSL/TLS certificate to an IP
- changing a network interface for an IP
- viewing a list of available IP addresses, SSL/TLS certificates, and interfaces

## Location

`%plesk_cli%`

## Usage

    ipmanage.exe <command> [<IP>] [
    <option 1> <param> [<option 2> <param>] ... [<option N> <param>]
    ]

## Example

The following command creates IP address 192.0.2.10 with a subnet mask 255.255.255.0, sets the Local Area Connection interface for it, makes this IP address exclusive (available for using by only one client), and assigns the SSL/TLS certificate called My certificate to the IP.

    plesk bin ipmanage.exe --create 192.0.2.10 -mask 255.255.255.0 -interface "\"Local Area Connection"\" -type exclusive -ssl_certificate "My certificate"

## Commands

Command | Parameter | Description | Example
--- | --- | --- | ---
`--create` or `-c` | `<IP>` | Creates an IP address in Plesk database. Requires `-type`, `-ssl_certificate,` `-mask`, `-interface` options. | See Example above.
`--update` or `-u` | `<IP>` | Changes IP address properties. | To change IP 192.0.2.123 type to exclusive:
    plesk bin ipmanage.exe --update 192.0.2.123 -type exclusive
`--remove` or `-r` | `<IP>` | Removes an IP address from Plesk database. | To remove IP 192.0.2.123:
    plesk bin ipmanage.exe --remove 192.0.2.123
`--reread` |  | Rereads the IP addresses. | To reread the IP addresses:
    plesk bin ipmanage.exe --reread
`--ip_list` or `-l` |  | Outputs the list of existing IP addresses. | To view the list of existing IP addresses:
    plesk bin ipmanage.exe --ip_list
`--ssl_list` or `-s` |  | Outputs the list of available SSL/TLS certificates. | To view the list of available SSL/TLS certificates:
    plesk bin ipmanage.exe --ssl_list
`--inter_list` or `-f` |  | Outputs the list of available network interfaces. | To view the list of available network interfaces:
    plesk bin ipmanage.exe --inter_list
`--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.exe --xml-info
or
    ipmanage.exe -xi
`--reset_ssl_certificate` |  | Specifies a default SSL/TLS certificate to all available IP addresses. | To set default SSL/TLS certificate to all available IP addresses:
    plesk bin ipmanage.exe --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.exe --auto-remap-ip-addresses
`--change-ip` | `<IP>` | Reassigns the IP address. | To reassign the IP 192.168.1.2 to 192.168.1.3:
    plesk bin ipmanage.exe --change-ip 192.168.1.2 -mask 255
    .255.255.0 -interface "\"Local Area Connection"\" -ip 192.168.1.3
`--help` or `-h` |  | Outputs help on the utility use. |
    plesk bin ipmanage.exe --help

## Options

Option | Parameter | Description | Example
--- | --- | --- | ---
`-type` | `shared|exclusive` | Defines the IP address type: an exclusive IP can be used by only one client, a shared IP can be used by many clients. Required with `--create`. | To change IP 192.0.2.123 type to exclusive:
    plesk bin ipmanage.exe -u 192.0.2.123 -type exclusive
`-ssl_certificate` | `<name>` | Specifies a name of SSL/TLS certificate to be used for the IP. Required with `--create`. | To assign a default certificate to IP 192.0.2.1:
    plesk bin ipmanage.exe -u 192.0.2.1 -ssl_certificate "Default Certificate"
`-mask` | `<mask>` | Specifies the IP subnet mask. Used with `--create` only. Required with `--create`. | To create an IP with 24-bit mask see Example above.
`-interface` | `<dev>` | Specifies the name of the physical network interface. Used with `--create` only. Required with `--create`. | To create an IP for the network interface “Local Area Connection” see Example above.
`-ftps` | `true|false` | Allowsprohibits using FTPS, i.e., accessing FTP associated with the IP over SSL/TLS. | To allow FTPS on IP 192.0.2.1:
    plesk bin ipmanage.exe -u 192.0.2.1 -ftps true
`-public_ip` | `<IP>` | Maps an internal IP to a public one to create NAT. If used with an empty parameter, removes mapping. Used with the `--create` and `--update` commands. | To map an internal IP 192.168.1.2 to a public IP 198.51.100.1:
    plesk bin ipmanage.exe -u 192.168.1.2 -public_ip 198.51.100.1
To remove mapping of an internal IP 192.168.1.2 to a public IP:
    plesk bin ipmanage.exe -u 192.168.1.2 -public_ip ""
`-ip` | `<IP>` | Maps the target IP address. | To reassign the IP 192.168.1.2 to 192.168.1.3:
    plesk bin ipmanage.exe --change-ip 192.168.1.2 -mask 255.255.255.0 -interface "\"Local Area Connection"\" -ip 192.168.1.3

Notes

1. It is preferable that the name of the SSL/TLS certificate is specified as a double-quoted string. If the name of the SSL/TLS certificate contains spaces, double quotes are mandatory.
2. The name of the network interface must be specified as a double-quoted string. If the name of the network interface contains spaces, then it must be enclosed with `"\"` characters. For example, the default name for the network adapter used in Windows is Local Area Connection. To specify it, use the following format: -interface “”Local Area Connection””