uffDbImportExport

The uffDbImportExport method imports or exports uff db data files from a node and uploads them a remote server.

Note: The remote SFTP port is currently hard coded to port 22. The local directory and remote directory locations must be the specific directory/sub-directory path based on the Cluster data being exported/imported.

args0


The IP address for the FTP server where you plan to send the file.
args1


The port you want to use for FTP (usually 22).
args2


The username for logging in to the FTP server.
args3


The password for logging in to the FTP server.
args4


The remote directory for the import/export.
args5


The local directory for the import/export.
args6


The desired action, import or export.
Response Parameters (return element children)
result


A result code such as internal.request.complete that describes the result. See Application Layer Messages and Status & Types in the Developer's Guide for details.
If xsi:nil="true" then there are no remote messages. Otherwise:

  • error - Boolean, true if an error occurred, false otherwise
  • info - Boolean
  • messageKey - A result code such as internal.request.denied.lock if such an error occurred
  • messageType - The type of error, such as internal.message.error
  • warning - Boolean, true if this is a warning, false if not
  • messageParams - Information about the message (there can be more than one messageParam)
uffDbStatus


A status code such as error.undetermined.result may occur if the result cannot be determined. See Error Codes in the Developer's Guide for details.
Example Request and Response
Request Response 
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ser="http://services.api.platform.vos.cisco.com">
	<soapenv:Header xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">
		<wsa:Action>urn: uffDbImportExport</wsa:Action>
		<wsa:MessageID>uuid:63e5d8ca-dcac-40af-916b-d32ec3382d0f</wsa:MessageID>
		<wsa:ReplyTo>
			<wsa:Address>http://www.w3.org/2005/08/addressing/anonymous</wsa:Address>
		</wsa:ReplyTo>
		<wsa:To></wsa:To>
	</soapenv:Header>
	<soapenv:Body>
		<uffDbImportExport xmlns="http://services.api.platform.vos.cisco.com">
			<ser:args0>infyvoscm28-lnx.cisco.com.</ser:args0>
			<ser:args1>22</ser:args1>
			<ser:args2>root</ser:args2>
			<ser:args3>cisco123</ser:args3>
			<ser:args4>/home/rvurimi/</ser:args4>
			<ser:args5>/home/rvurimi/</ser:args5>
			<ser:args6>export</ser:args6>
		</uffDbImportExport ></soapenv:Body>
</soapenv:Envelope>

								
<?xml version='1.0' encoding='UTF-8'?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
	<soapenv:Header xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">
		<wsa:To>http://www.w3.org/2005/08/addressing/anonymous</wsa:To>
		<wsa:MessageID>urn:uuid:9c1fbf48-3909-4049-987f-3426429a75f6</wsa:MessageID>
		<wsa:Action>urn:uffDbImportExportResponse</wsa:Action>
		<wsa:RelatesTo>uuid:63e5d8ca-dcac-40af-916b-d32ec3382d0f</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:uffDbImportExportResponse xmlns:ns="http://services.api.platform.vos.cisco.com">
			<ns:return xmlns:ax2114="http://api.platform.vos.cisco.com/xsd" xmlns:ax2113="http://element.services.api.platform.vos.cisco.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ax2113:UffDbImportExportResponse">
				<ax2113:remoteMessages xsi:type="ax2113:RemoteMessage">
					<ax2114:error>true</ax2114:error>
					<ax2114:info>false</ax2114:info>
					<ax2114:messageKey>internal.request.denied.lock</ax2114:messageKey>
					<ax2114:messageType>internal.message.error</ax2114:messageType>
					<ax2114:warning>false</ax2114:warning>
					<ax2113:messageParams>platform.api.network.address</ax2113:messageParams>
					<ax2113:messageParams>27543@rwerer</ax2113:messageParams>
					<ax2113:messageParams>CreateUffDbImportExportThread-211</ax2113:messageParams>
				</ax2113:remoteMessages>
				<ax2113:result>internal.request.failed</ax2113:result>
				<ax2113:uffDbStatus>error.undetermined.result</ax2113:uffDbStatus>
			</ns:return>
		</ns:uffDbImportExportResponse>
	</soapenv:Body>
</soapenv:Envelope>