Syntax elements for xmlaccess.sh command line

Syntax elements for xmlaccess.sh command line

This topic lists the syntax elements for using the XML configuration interface command line client over an HTTP connection.
For information about the XML syntax elements for a secure HTTPS connection see the topic about XML Syntax elements for using a secure connection with SSL.

Syntax element Description
xmlaccess Shell script located in WP_PROFILE/PortalServer/bin
-in Name of a file containing the XML request (configuration export or update) that should be processed.
-user and -password User identification and password describing the authority under which the request should be processed. For the value for user specify the short user name as specified during login; full distinguished names (DN) are not supported. xmlaccess.sh is only accessible to users that have the manager role on the virtual resource XML_ACCESS and the administrator role on the virtual resource PORTAL.
-askForCredential Use the parameter askForCredential and leave out the parameters user and password. xmlaccess.sh will then prompt you for the user ID and password. The parameter askForCredential requires no value to be specified.
-useEncryptedCredentials Provide the user credentials in a properties file rather than with the XML command.
-noUpdateProperties Use this option additionally with the option useEncryptedCredentials, if we do not want to have the encrypted credentials written back to the properties file.
-url URL to access the configuration servlet. This URL consists of the host name, the base URI as specified during installation (for example /wps), and the servlet extension /config.
-out Name of the result file containing the XML output. This file gives a result status and thereby indicates whether the XML request was performed successfully, or what errors might have occurred. In the case of an XML export, this file contains the exported configuration. We can later use this file to re-import the exported configuration.

Parent Basic XML command line syntax

Syntax element	Description
xmlaccess	Shell script located in WP_PROFILE/PortalServer/bin
-in	Name of a file containing the XML request (configuration export or update) that should be processed.
-user and -password	User identification and password describing the authority under which the request should be processed. For the value for user specify the short user name as specified during login; full distinguished names (DN) are not supported. xmlaccess.sh is only accessible to users that have the manager role on the virtual resource XML_ACCESS and the administrator role on the virtual resource PORTAL.
-askForCredential	Use the parameter askForCredential and leave out the parameters user and password. xmlaccess.sh will then prompt you for the user ID and password. The parameter askForCredential requires no value to be specified.
-useEncryptedCredentials	Provide the user credentials in a properties file rather than with the XML command.
-noUpdateProperties	Use this option additionally with the option useEncryptedCredentials, if we do not want to have the encrypted credentials written back to the properties file.
-url	URL to access the configuration servlet. This URL consists of the host name, the base URI as specified during installation (for example /wps), and the servlet extension /config.
-out	Name of the result file containing the XML output. This file gives a result status and thereby indicates whether the XML request was performed successfully, or what errors might have occurred. In the case of an XML export, this file contains the exported configuration. We can later use this file to re-import the exported configuration.