Parallels H-Sphere Documentation Developer Guide Javadoc XML API

 

H-Sphere XML API: User FTP Services

2.5 Beta 2 and higher
 
 

Related Docs:   H-Sphere XML API Reference Javadoc XML API

Last modified: 21 Aug 2006

 

WARNING: This documentation covers Parallels H-Sphere versions up to 3.1. For the latest up-to-date Parallels H-Sphere documentation, please proceed to the official Parallels site.

WARNING:
This documentation is outdated! Please refer to Javadoc XML API for up-to-date reference!

Actions:

 

Action: changeFtpPass

Description: adds a new virtual host

Parameters:

AuthToken:at - authentication information
String:newPass - new password

Response: empty

Example:

 <soapenv:Body>
        <ns1:changeFtpPass soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserFtpServices">
           <at href="#id0"/>
           <newPass xsi:type="xsd:string">katon</newPass>
        </ns1:changeFtpPass>
        <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:UserFtpServices">
           <password xsi:type="soapenc:string">katon</password>
           <role xsi:type="ns2:Role" xsi:nil="true"/>
           <accountId href="#id1"/>
           <login xsi:type="soapenc:string">katon-u</login>
        </multiRef>
        <multiRef id="id1" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="xsd:int" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">0</multiRef>
     </soapenv:Body>

     <soapenv:Body>
        <ns1:changeFtpPassResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserFtpServices"/>
     </soapenv:Body>

 

Action: addFtpSubUser

Description: adds a new FTP subuser

Parameters:

AuthToken:at - authentication information
String:username - user name
String:dir - directory name
String:password - password

Response: empty

Example:

<soapenv:Body>
        <ns1:addFtpSubUser soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserFtpServices">
           <at href="#id0"/>
           <subUserName xsi:type="xsd:string">asubuser</subUserName>
           <dir xsi:type="xsd:string"></dir>
           <subUserPassword xsi:type="xsd:string">password</subUserPassword>
        </ns1:addFtpSubUser>
        <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:UserFtpServices">
           <password xsi:type="soapenc:string">katon</password>
           <role xsi:type="ns2:Role" xsi:nil="true"/>
           <accountId href="#id1"/>
           <login xsi:type="soapenc:string">katon-u</login>
        </multiRef>
        <multiRef id="id1" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="xsd:int" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">0</multiRef>
     </soapenv:Body>

     <soapenv:Body>
        <ns1:addFtpSubUserResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserFtpServices"/>
     </soapenv:Body>

 

Action: delFtpSubUser

Description: deletes FTP subuser

Parameters:

AuthToken:at - authentication information
String:username - user name

Response: empty

Example:

    <soapenv:Body>
        <ns1:delFtpSubUser soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserFtpServices">
           <at href="#id0"/>
           <subUserName xsi:type="xsd:string">asubuser</subUserName>
        </ns1:delFtpSubUser>
        <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:UserFtpServices">
           <password xsi:type="soapenc:string">katon</password>
           <role xsi:type="ns2:Role" xsi:nil="true"/>
           <accountId href="#id1"/>
           <login xsi:type="soapenc:string">katon-u</login>
        </multiRef>
        <multiRef id="id1" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="xsd:int" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">0</multiRef>
     </soapenv:Body>

     <soapenv:Body>
        <ns1:delFtpSubUserResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserFtpServices"/>
     </soapenv:Body>

 

Action: changeSubUserPass

Description: changes FTP subuser password

Parameters:

AuthToken:at - authentication information
String:subUserName - FTP subuser login
String:newPass - new password

Response: empty

Example:

     <soapenv:Body>
        <ns1:changeSubUserPass soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserFtpServices">
           <at href="#id0"/>
           <subUserName xsi:type="xsd:string">asubuser</subUserName>
           <newPass xsi:type="xsd:string">MyNewPaSS</newPass>
        </ns1:changeSubUserPass>
        <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:UserFtpServices">
           <password xsi:type="soapenc:string">katon</password>
           <role xsi:type="ns2:Role" xsi:nil="true"/>
           <accountId href="#id1"/>
           <login xsi:type="soapenc:string">katon-u</login>
        </multiRef>
        <multiRef id="id1" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="xsd:int" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">0</multiRef>
     </soapenv:Body>

     <soapenv:Body>
        <ns1:changeSubUserPassResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserFtpServices"/>
     </soapenv:Body>

 

Action: getFTPSubUsers

Description: gets FTP subuser

Parameters:

AuthToken:at - authentication information

Response: Array of FTPSubUser logins

Example:

    <soapenv:Body>
        <ns1:getFTPSubUsers soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserFtpServices">
           <at href="#id0"/>
        </ns1:getFTPSubUsers>
        <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:UserFtpServices">
           <password xsi:type="soapenc:string">katon</password>
           <role xsi:type="ns2:Role" xsi:nil="true"/>
           <accountId href="#id1"/>
           <login xsi:type="soapenc:string">katon-u</login>
        </multiRef>
        <multiRef id="id1" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="xsd:int" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">0</multiRef>
     </soapenv:Body>

     <soapenv:Body>
        <ns1:getFTPSubUsersResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserFtpServices">
           <getFTPSubUsersReturn soapenc:arrayType="xsd:anyType[3]" xsi:type="soapenc:Array" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
              <getFTPSubUsersReturn xsi:type="soapenc:string">subunix</getFTPSubUsersReturn>
              <getFTPSubUsersReturn xsi:type="soapenc:string">vasya</getFTPSubUsersReturn>
              <getFTPSubUsersReturn xsi:type="soapenc:string">asubuser</getFTPSubUsersReturn>
           </getFTPSubUsersReturn>
        </ns1:getFTPSubUsersResponse>
     </soapenv:Body>

Related Docs:   H-Sphere XML API Reference Javadoc XML API



© Copyright 2017. Parallels Holdings. All rights reserved.