Previous page Previous page

Next page Next page

Locate page Locate page

Print this page

IP Addresses: ipmanage Utility

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

Syntax

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.

# ./ipmanage --create 192.0.2.78 -mask 255.255.255.0 -interface "Local Area Connection" -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:

# ./ipmanage --create 192.0.2.78 -type shared -mask 255.255.0.0 -interface "Local Area Connection"

or

# ./ipmanage -c 192.0.2.78 -type shared -mask 255.255.0.0 -interface "Local Area Connection"

--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:

# ./ipmanage --update 192.0.2.78 -type exclusive

or

# ./ipmanage --update 192.0.2.78 -type exclusive

--remove or -r

<IP_address>

Deletes an IP address.

To remove IP address 192.0.2.78:

# ./ipmanage --remove 192.0.2.78

or

# ./ipmanage -r 192.0.2.78

--ip_list or -l

 

Displays the list of available IP addresses.

To view the list of available IP addresses:

# ./ipmanage --ip_list

or

# ./ipmanage -l

--ssl_list or -s

 

Displays the list of available SSL certificates.

To view the list of available SSL certificates:

# ./ipmanage --ssl_list

or

# ./ipmanage -s

--inter_list or -f

 

Displays the list of available interfaces.

To view the list of available network interfaces:

# ./ipmanage --inter_list

or

# ./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:

# ./ipmanage --xml-info

or

# ./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:

# ./ipmanage --reset_ssl_certificate

--help or -h

 

Displays help on the use of the utility.

To view help on the use of the ipmanage utility:

# ./ipmanage --help

or

# ./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:

# ./ipmanage -u 192.0.2.78 -type exclusive

-ssl_certificate

<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:

# ./ipmanage -u 192.0.2.78 -ssl_certificate "New Certificate"

-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:

# ./ipmanage -c 192.0.2.78 -type shared -mask 16 -interface "Local Area Connection"

-interface

<string>

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

Required with the --create.

Used with the --create only.