Changing IP Address Type in Reseller's IP Pool

The ippool-set-ip operation is used to change type of IP addresses located in a reseller's IP pool.

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 

Request Packet Structure

A request XML packet changing IP address type includes the ippool-set-ip node:

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

 

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

ipPoolResellerSet

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

  • The reseller-id node is required. It specifies ID of the reseller account which IP address is to be modified. Data type: id_type (common.xsd).
  • The filter node is required. It specifies IP address which type is to be changed. If this node is empty, the operation will modify all IP addresses from the reseller's IP pool. Data type: none.
    • The ip-address node is optional. It specifies IP addresses which types are to be modified. Data type: ip_address (common.xsd).
  • The values node is required. It specifies ip-address type which is to be set. Data type: none.
    •  The ip-type node is required.It specifies IP address type. Data type: ipType (plesk_common.xsd). Allowed values: shared | exclusive.

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

 

Response Packet Structure

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

ResellerIpPoolOperationOutput-set

Note: The interactive schema navigator for all response packets is available here: http://plesk.github.io/api-schemas/1.6.8.0/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 is not returned for this operation.

 

Operation-specific Errors

  • 1015 - reseller is not found
  • 1013 - IP address is not found in reseller's IP pool
 

Samples

The following packet sets IP address type to shared:

<packet version="1.6.0.0">
<reseller>
<ippool-set-ip>
   <reseller-id>10</reseller-id>
   <filter>
      <ip-address>192.0.2.40</ip-address>
   </filter>
   <values>
      <ip-type>shared</ip-type>
   </values>
</reseller>
</packet>

Response:

<packet version="1.6.0.0">
  <reseller>
    <ippool-set-ip>
      <result>
        <status>ok</status>
        <ip-address>192.0.2.40</ip-address>
      </result>
    </ippool-set-ip>
  </reseller>
</packet> 
 

Leave your feedback on this topic here

If you have questions or need support, please visit the Plesk forum or contact your hosting provider.
The comments below are for feedback on the documentation only. No timely answers or help will be provided.