PLESK RPC API

Section 4.5 Performing Operations on IP Addresses

 The given structures allow for creating packets with the information used for managing IP addresses.

Schema ip_input.xsd


schema location:  ip_input.xsd
 
Elements  Complex types 
packet  filterType 
getType 


schema location:  plesk_common.xsd
 
Complex types  Simple types 
buttonDataType  expandIPUsageStatus 
forwardingURL 
garbageOutput 
ipType 
netInterface 
objectStatus 
pleskOS 


schema location:  common.xsd
 
Complex types  Simple types 
resultType  base64 
boolean 
date 
datetime 
double 
emailType 
id_type 
int 
ip_address 
passwdType 
result_status 
short 
size 
string 
text 
unsignedInt 
unsignedShort 
urlType 
zipcodeType 


element packet
diagram
properties
content complex
children ip
attributes
Name  Type  Use  Default  Fixed  Annotation
version  stringrequired      
annotation
documentation 
Root node for any input

element packet/ip
diagram
properties
isRef 0
content complex
children add get set del
annotation
documentation 
IP operator

element packet/ip/add
diagram
properties
isRef 0
content complex
children ip_address netmask type interface
annotation
documentation 
Add IP address to the Plesk server

element packet/ip/add/ip_address
diagram
type ip_address
properties
isRef 0
content simple
facets
minLength 1
maxLength 15
whiteSpace collapse

element packet/ip/add/netmask
diagram
type ip_address
properties
isRef 0
content simple
facets
minLength 1
maxLength 15
whiteSpace collapse

element packet/ip/add/type
diagram
type ipType
properties
isRef 0
content simple
facets
whiteSpace collapse
enumeration shared
enumeration exclusive

element packet/ip/add/interface
diagram
type netInterface
properties
isRef 0
content simple
facets
minLength 1
maxLength 200
whiteSpace collapse

element packet/ip/get
diagram
properties
isRef 0
annotation
documentation 
Get server IP address(es)

element packet/ip/set
diagram
properties
isRef 0
content complex
children filter type
annotation
documentation 
Setup IP address(es) type

element packet/ip/set/filter
diagram
type filterType
properties
isRef 0
content complex
children ip_address
annotation
documentation 
Filter IP addresses to be deleted

element packet/ip/set/type
diagram
type ipType
properties
isRef 0
content simple
facets
whiteSpace collapse
enumeration shared
enumeration exclusive
annotation
documentation 
The IP address type to be set

element packet/ip/del
diagram
properties
isRef 0
content complex
children filter
annotation
documentation 
Remove the IP address from the Plesk server

element packet/ip/del/filter
diagram
type filterType
properties
isRef 0
content complex
children ip_address
annotation
documentation 
Filter IP addresses to be deleted

complexType filterType
diagram
children ip_address
used by
elements packet/ip/set/filter packet/ip/del/filter
annotation
documentation 
Filter the list of client accounts

element filterType/ip_address
diagram
type ip_address
properties
isRef 0
content simple
facets
minLength 1
maxLength 15
whiteSpace collapse
annotation
documentation 
IP address value

complexType getType
diagram
children key gen_info components stat admin
annotation
documentation 
Request server info

element getType/key
diagram
properties
isRef 0
annotation
documentation 
Plesk licence key information

element getType/gen_info
diagram
properties
isRef 0
annotation
documentation 
Server general information

element getType/components
diagram
properties
isRef 0
annotation
documentation 
Server componets

element getType/stat
diagram
properties
isRef 0
annotation
documentation 
Server statistics

element getType/admin
diagram
properties
isRef 0
annotation
documentation 
Server adminstrator information

complexType buttonDataType
diagram
children code type name name_id group_name group_name_id href js_onclick enabled new_window tabindex
annotation
documentation 
Button data

element buttonDataType/code
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Button string ID

element buttonDataType/type
diagram
type restriction of string
properties
isRef 0
content simple
facets
whiteSpace collapse
enumeration link_button
enumeration comm_button
annotation
documentation 
Button type

element buttonDataType/name
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Button name

element buttonDataType/name_id
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Button name (string ID for localization)

element buttonDataType/group_name
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Button owner group name

element buttonDataType/group_name_id
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Button owner group name (string ID for localization)

element buttonDataType/href
diagram
type urlType
properties
isRef 0
content simple
facets
maxLength 255
whiteSpace collapse
annotation
documentation 
Button linked to

element buttonDataType/js_onclick
diagram
type text
properties
isRef 0
content simple
facets
whiteSpace preserve
annotation
documentation 
JavaScript code associated with the button onClick event handle

element buttonDataType/enabled
diagram
type boolean
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Button enabled flag

element buttonDataType/new_window
diagram
type boolean
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
New window flag. It should be specified in protocol 1.3.1.7 and higher

element buttonDataType/tabindex
diagram
type int
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse
annotation
documentation 
Button tabulation index

simpleType expandIPUsageStatus
type restriction of string
facets
whiteSpace collapse
enumeration free
enumeration reserved
enumeration assigned
annotation
documentation 
IP address usage status in Expand DB

simpleType forwardingURL
type restriction of string
facets
minLength 1
maxLength 255
whiteSpace collapse
annotation
documentation 
URL, only symbolic name, not an IP

simpleType garbageOutput
type string
facets
whiteSpace collapse
annotation
documentation 
Garbage Output, for debug

simpleType ipType
type restriction of string
used by
elements packet/ip/add/type packet/ip/set/type
facets
whiteSpace collapse
enumeration shared
enumeration exclusive
annotation
documentation 
IP address usage status in Expand DB

simpleType netInterface
type restriction of string
used by
element packet/ip/add/interface
facets
minLength 1
maxLength 200
whiteSpace collapse
annotation
documentation 
Server Network Interface name

simpleType objectStatus
type int
facets
whiteSpace collapse
annotation
documentation 
Plesk client and domain status.
Bit mask with bit flags:

0 - object is active
4 - object is under backup/restore

16 - object is disabled by Administrator

64 - object is disabled by Client

256 - object expired
Only 0, 16 and 64 flags are available for setting

simpleType pleskOS
type restriction of string
facets
whiteSpace collapse
enumeration Windows
enumeration RedHat
annotation
documentation 
Operation System, see enumerations for details

complexType resultType
diagram
children status errcode errtext
annotation
documentation 
Operation result

element resultType/status
diagram
type result_status
properties
isRef 0
content simple
facets
enumeration ok
enumeration error
annotation
documentation 
Result status (ok/error)

element resultType/errcode
diagram
type unsignedInt
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Error code if error occurred

element resultType/errtext
diagram
type xs:string
properties
isRef 0
content simple
annotation
documentation 
Error message if error occurred

simpleType base64
type restriction of xs:base64Binary
facets
whiteSpace collapse

simpleType boolean
type restriction of xs:boolean
used by
elements buttonDataType/enabled buttonDataType/new_window
facets
whiteSpace collapse

simpleType date
type restriction of xs:date
facets
whiteSpace collapse

simpleType datetime
type restriction of xs:dateTime
facets
whiteSpace collapse

simpleType double
type restriction of xs:double
facets
whiteSpace collapse

simpleType emailType
type restriction of string
facets
minLength 3
maxLength 255
whiteSpace collapse
pattern [\-\p{L}\p{N}\.]*@([\p{L}\p{N}][\-\p{L}\p{N}]*\.)*[\p{L}][\-\p{L}\p{N}]*\.?
annotation
documentation 
Any e-mail address

simpleType id_type
type restriction of xs:positiveInteger
facets
whiteSpace collapse
annotation
documentation 
Item ID

simpleType int
type restriction of xs:integer
used by
element buttonDataType/tabindex
simpleType objectStatus
facets
whiteSpace collapse

simpleType ip_address
type restriction of xs:string
used by
elements packet/ip/add/ip_address filterType/ip_address packet/ip/add/netmask
facets
minLength 1
maxLength 15
whiteSpace collapse

simpleType passwdType
type restriction of string
facets
minLength 4
maxLength 64
whiteSpace collapse
annotation
documentation 
Typical password

simpleType result_status
type restriction of xs:string
used by
element resultType/status
facets
enumeration ok
enumeration error
annotation
documentation 
Result status

simpleType short
type restriction of xs:short
facets
whiteSpace collapse

simpleType size
type restriction of xs:unsignedLong
facets
whiteSpace collapse

simpleType string
type restriction of xs:string
used by
elements buttonDataType/code buttonDataType/group_name buttonDataType/group_name_id buttonDataType/name buttonDataType/name_id buttonDataType/type
simpleTypes emailType expandIPUsageStatus forwardingURL garbageOutput ipType netInterface passwdType pleskOS urlType zipcodeType
attribute packet/@version
facets
whiteSpace collapse

simpleType text
type restriction of xs:string
used by
element buttonDataType/js_onclick
facets
whiteSpace preserve

simpleType unsignedInt
type restriction of xs:unsignedInt
used by
element resultType/errcode
facets
whiteSpace collapse

simpleType unsignedShort
type restriction of xs:unsignedShort
facets
whiteSpace collapse

simpleType urlType
type restriction of string
used by
element buttonDataType/href
facets
maxLength 255
whiteSpace collapse
annotation
documentation 
URL

simpleType zipcodeType
type restriction of string
facets
maxLength 10
whiteSpace collapse


Schema ip_output.xsd


schema location:  ip_output.xsd
 
Elements 
packet 


schema location:  plesk_common.xsd
 
Complex types  Simple types 
buttonDataType  expandIPUsageStatus 
forwardingURL 
garbageOutput 
ipType 
netInterface 
objectStatus 
pleskOS 


schema location:  common.xsd
 
Complex types  Simple types 
resultType  base64 
boolean 
date 
datetime 
double 
emailType 
id_type 
int 
ip_address 
passwdType 
result_status 
short 
size 
string 
text 
unsignedInt 
unsignedShort 
urlType 
zipcodeType 


element packet
diagram
properties
content complex
children ip system output
attributes
Name  Type  Use  Default  Fixed  Annotation
version  stringrequired      
annotation
documentation 
Root node for any input

element packet/ip
diagram
properties
isRef 0
content complex
children add get set del
annotation
documentation 
Server operator

element packet/ip/add
diagram
properties
isRef 0
content complex
children result

element packet/ip/add/result
diagram
type extension of resultType
properties
isRef 0
content complex
children status errcode errtext ip_address

element packet/ip/add/result/ip_address
diagram
type ip_address
properties
isRef 0
content simple
facets
minLength 1
maxLength 15
whiteSpace collapse
annotation
documentation 
New IP address value

element packet/ip/get
diagram
properties
isRef 0
content complex
children result
annotation
documentation 
The result of showing the list of IP addresses

element packet/ip/get/result
diagram
type extension of resultType
properties
isRef 0
content complex
children status errcode errtext addresses

element packet/ip/get/result/addresses
diagram
properties
isRef 0
content complex
children ip

element packet/ip/get/result/addresses/ip
diagram
properties
isRef 0
content complex
children ip_address netmask type interface

element packet/ip/get/result/addresses/ip/ip_address
diagram
type ip_address
properties
isRef 0
content simple
facets
minLength 1
maxLength 15
whiteSpace collapse

element packet/ip/get/result/addresses/ip/netmask
diagram
type ip_address
properties
isRef 0
content simple
facets
minLength 1
maxLength 15
whiteSpace collapse

element packet/ip/get/result/addresses/ip/type
diagram
type ipType
properties
isRef 0
content simple
facets
whiteSpace collapse
enumeration shared
enumeration exclusive

element packet/ip/get/result/addresses/ip/interface
diagram
type netInterface
properties
isRef 0
content simple
facets
minLength 1
maxLength 200
whiteSpace collapse

element packet/ip/set
diagram
properties
isRef 0
content complex
children result
annotation
documentation 
"Setup" operation result

element packet/ip/set/result
diagram
type extension of resultType
properties
isRef 0
content complex
children status errcode errtext ip_address

element packet/ip/set/result/ip_address
diagram
type ip_address
properties
isRef 0
content simple
facets
minLength 1
maxLength 15
whiteSpace collapse
annotation
documentation 
Operated IP addresses

element packet/ip/del
diagram
properties
isRef 0
content complex
children result
annotation
documentation 
The result of deleting IP address(es)

element packet/ip/del/result
diagram
type extension of resultType
properties
isRef 0
content complex
children status errcode errtext ip_address

element packet/ip/del/result/ip_address
diagram
type ip_address
properties
isRef 0
content simple
facets
minLength 1
maxLength 15
whiteSpace collapse
annotation
documentation 
Deleted IP addresses

element packet/system
diagram
type resultType
properties
isRef 0
content complex
children status errcode errtext
annotation
documentation 
The result from PA system level

element packet/output
diagram
type garbageOutput
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Debug garbage

complexType buttonDataType
diagram
children code type name name_id group_name group_name_id href js_onclick enabled new_window tabindex
annotation
documentation 
Button data

element buttonDataType/code
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Button string ID

element buttonDataType/type
diagram
type restriction of string
properties
isRef 0
content simple
facets
whiteSpace collapse
enumeration link_button
enumeration comm_button
annotation
documentation 
Button type

element buttonDataType/name
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Button name

element buttonDataType/name_id
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Button name (string ID for localization)

element buttonDataType/group_name
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Button owner group name

element buttonDataType/group_name_id
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Button owner group name (string ID for localization)

element buttonDataType/href
diagram
type urlType
properties
isRef 0
content simple
facets
maxLength 255
whiteSpace collapse
annotation
documentation 
Button linked to

element buttonDataType/js_onclick
diagram
type text
properties
isRef 0
content simple
facets
whiteSpace preserve
annotation
documentation 
JavaScript code associated with the button onClick event handle

element buttonDataType/enabled
diagram
type boolean
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Button enabled flag

element buttonDataType/new_window
diagram
type boolean
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
New window flag. It should be specified in protocol 1.3.1.7 and higher

element buttonDataType/tabindex
diagram
type int
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse
annotation
documentation 
Button tabulation index

simpleType expandIPUsageStatus
type restriction of string
facets
whiteSpace collapse
enumeration free
enumeration reserved
enumeration assigned
annotation
documentation 
IP address usage status in Expand DB

simpleType forwardingURL
type restriction of string
facets
minLength 1
maxLength 255
whiteSpace collapse
annotation
documentation 
URL, only symbolic name, not an IP

simpleType garbageOutput
type string
used by
element packet/output
facets
whiteSpace collapse
annotation
documentation 
Garbage Output, for debug

simpleType ipType
type restriction of string
used by
element packet/ip/get/result/addresses/ip/type
facets
whiteSpace collapse
enumeration shared
enumeration exclusive
annotation
documentation 
IP address usage status in Expand DB

simpleType netInterface
type restriction of string
used by
element packet/ip/get/result/addresses/ip/interface
facets
minLength 1
maxLength 200
whiteSpace collapse
annotation
documentation 
Server Network Interface name

simpleType objectStatus
type int
facets
whiteSpace collapse
annotation
documentation 
Plesk client and domain status.
Bit mask with bit flags:

0 - object is active
4 - object is under backup/restore

16 - object is disabled by Administrator

64 - object is disabled by Client

256 - object expired
Only 0, 16 and 64 flags are available for setting

simpleType pleskOS
type restriction of string
facets
whiteSpace collapse
enumeration Windows
enumeration RedHat
annotation
documentation 
Operation System, see enumerations for details

complexType resultType
diagram
children status errcode errtext
used by
elements packet/ip/add/result packet/ip/get/result packet/ip/set/result packet/ip/del/result packet/system
annotation
documentation 
Operation result

element resultType/status
diagram
type result_status
properties
isRef 0
content simple
facets
enumeration ok
enumeration error
annotation
documentation 
Result status (ok/error)

element resultType/errcode
diagram
type unsignedInt
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Error code if error occurred

element resultType/errtext
diagram
type xs:string
properties
isRef 0
content simple
annotation
documentation 
Error message if error occurred

simpleType base64
type restriction of xs:base64Binary
facets
whiteSpace collapse

simpleType boolean
type restriction of xs:boolean
used by
elements buttonDataType/enabled buttonDataType/new_window
facets
whiteSpace collapse

simpleType date
type restriction of xs:date
facets
whiteSpace collapse

simpleType datetime
type restriction of xs:dateTime
facets
whiteSpace collapse

simpleType double
type restriction of xs:double
facets
whiteSpace collapse

simpleType emailType
type restriction of string
facets
minLength 3
maxLength 255
whiteSpace collapse
pattern [\-\p{L}\p{N}\.]*@([\p{L}\p{N}][\-\p{L}\p{N}]*\.)*[\p{L}][\-\p{L}\p{N}]*\.?
annotation
documentation 
Any e-mail address

simpleType id_type
type restriction of xs:positiveInteger
facets
whiteSpace collapse
annotation
documentation 
Item ID

simpleType int
type restriction of xs:integer
used by
element buttonDataType/tabindex
simpleType objectStatus
facets
whiteSpace collapse

simpleType ip_address
type restriction of xs:string
used by
elements packet/ip/add/result/ip_address packet/ip/get/result/addresses/ip/ip_address packet/ip/set/result/ip_address packet/ip/del/result/ip_address packet/ip/get/result/addresses/ip/netmask
facets
minLength 1
maxLength 15
whiteSpace collapse

simpleType passwdType
type restriction of string
facets
minLength 4
maxLength 64
whiteSpace collapse
annotation
documentation 
Typical password

simpleType result_status
type restriction of xs:string
used by
element resultType/status
facets
enumeration ok
enumeration error
annotation
documentation 
Result status

simpleType short
type restriction of xs:short
facets
whiteSpace collapse

simpleType size
type restriction of xs:unsignedLong
facets
whiteSpace collapse

simpleType string
type restriction of xs:string
used by
elements buttonDataType/code buttonDataType/group_name buttonDataType/group_name_id buttonDataType/name buttonDataType/name_id buttonDataType/type
simpleTypes emailType expandIPUsageStatus forwardingURL garbageOutput ipType netInterface passwdType pleskOS urlType zipcodeType
attribute packet/@version
facets
whiteSpace collapse

simpleType text
type restriction of xs:string
used by
element buttonDataType/js_onclick
facets
whiteSpace preserve

simpleType unsignedInt
type restriction of xs:unsignedInt
used by
element resultType/errcode
facets
whiteSpace collapse

simpleType unsignedShort
type restriction of xs:unsignedShort
facets
whiteSpace collapse

simpleType urlType
type restriction of string
used by
element buttonDataType/href
facets
maxLength 255
whiteSpace collapse
annotation
documentation 
URL

simpleType zipcodeType
type restriction of string
facets
maxLength 10
whiteSpace collapse

to top