The ippool-add-ip operation is used to add IP addresses to IP pool of a specified reseller account.

Request Packet Structure

A request XML packet adding a new IP address to a reseller’s IP pool includes the ippool-add-ip node:

<packet>
    <reseller>
        <ippool-add-ip>
            ...
        </ippool-add-ip>
    </reseller>
</packet>

The ippool-add-ip node is specified by the ResellerIpPoolOperation complex type (reseller.xsd). Its graphical representation is as follows:

image 60596

Note

The interactive schema navigator for all request packets is available here: http://plesk.github.io/api-schemas/1.6.9.1/agent_input.svg.

  • The reseller-id node is required. It specifies ID of a reseller account to which IP pool IP address is to be added. Data type: id_type (common.xsd).

  • The ip node is required. It specifies settings of IP address which is to be added to a reseller’s IP pool.

    •  The ip-address node is required. It specifies IP address which is to be added to a reseller’s IP pool. Data type: ip_address (common.xsd).

    • The ip-type node is optional. It specifies IP address type (shared or exclusive). Data type: ipType (plesk_common.xsd).

Note

When creating request packets, put nodes and elements in the order they follow in the packet structure.

Response Packet Structure

The ippool-add-ip node of the response packet is structured as follows:

image 60597

Note

The interactive schema navigator for all response packets is available here: http://plesk.github.io/api-schemas/1.6.9.1/agent_output.svg.

  • The result node is required. It wraps the response retrieved from the server. Data type: resultFilterType (common.xsd).

    • The status node is required. It specifies the execution status of the operation. Data type: result_status (common.xsd). Allowed values: ok|error.

    • The errcode node is required if the operation fails. It returns the error code. Data type: unsignedInt.

    • The errtext node is required if the operation fails. It returns the error message. Data type: string.

    • The ip-address node is required if the operation succeeds. It returns the IP address added to the reseller’s IP pool. Data type: ip_address (common.xsd).

    • The reseller-id node is optional. It returns the ID of the reseller account to IP pool of which the IP address was added. Data type: integer.

Possible Errors

1018 - IP address does not exist.

Samples

To add the 192.0.2.122 IP address to a reseller’s IP pool, use the following packet:

<packet>
    <reseller>
        <ippool-add-ip>
            <reseller-id>12</reseller-id>
            <ip>
                <ip-address>192.0.2.122</ip-address>
            </ip>
        </ippool-add-ip>
    </reseller>
</packet>

Response:

<packet>
    <reseller>
        <ippool-add-ip>
            <result>
                <status>ok</status>
                <ip-address>192.0.2.122</ip-address>
            </result>
        </ippool-add-ip>
    </reseller>
</packet>