Configtoxml_utility

From Messaging Server Technical Reference Wiki
Jump to: navigation, search


Syntax

  configtoxml [switches]

Restrictions

This is implemented as a Perl script, so a reasonably modern version of Perl must be installed on the system to run this.

Description

The configtoxml utility converts a legacy configuration to a Unified Configuration.

Switches

-32|-64

Installation is a 32 bit (-32) or 64 bit (-64) Messaging Server. Default is 64 bit.

--force, -f

Ignore safety checks: allow running as non-root and permit overwriting of any pre-existing Unified Configuration files.

Caution:Using this option may result in a non-functioning configuration. The restricted.cnf file must be owned by root or the user listed in that file.

--help, -h

Print usage information.

--instance INSTANCE, -i INSTANCE

Instance name to insert in the generated configuration files. The default is ims.

--location DIR, -l DIR

Read the legacy configuration files from the specified directory DIR. The default is the normal configuration directory.

--noactive-n

Do not generate an active configuration and do not move the legacy configuration files to config-root/legacy-config/. The generated Unified Configuration files will have the names config_.xml, xpass_.xml, and restricted_.cnf and will be written to config-root. This may not be used in conjuction with the --output or --undo switches.

--output CONFIG-FILE PASSWORD-FILE RESTRICTED-FILE, -o CONFIG-FILE PASSWORD-FILE RESTRICTED-FILE

Direct the Unified Configuration file output to the designated files. By default, the files config.xml, xpass.xml, and resricted.cnf are written to the config-root directory. This may not be used in conjunction with the --noactive or --undo switches.

--role ROLE, -r ROLE

Role name to insert in the generated configuration files. The default is to use ims.

--yes, -y

Pre-answer any confirmation questions with a "yes" response so that this script can be run without user intervention.

--undo, -u

Remove any active Unified Configuration files and restore any legacy configuration files.

Usage Notes

Usage Notes: Stop the Messaging Server before running the configtoxml command. Alternatively, use the --noactive switch to prevent writing out an active configuration.

When generating an active Unified Configuration, the configtoxml command moves all the processed legacy configuration files to the config-root/legacy-config directory.

The --undo switch removes the Unified Configuration and restores the legacy configuration files.

Example


# imsimta version
Oracle Communications Messaging Server 7u5-28.12 64bit (built Nov 5 2012)
libimta.so 7u5-28.12 64bit (built 15:58:11, May 23 2012)
Using /opt/sun/comms/messaging/config/imta.cnf (not compiled)
Linux host1.example.com 2.6.39-100.5.1.el5uek #1 SMP Tue Mar 6 20:25:25 EST 2012 x86_64 x86_64 x86_64 GNU/Linux

# configtoxml
WARNING: This procedure will produce an active Unified Configuration which
        will override any existing legacy configuration.

Continue anyway [no]? yes
Creating the directory /opt/sun/comms/messaging/config/legacy-config/
Moving the processed legacy configuration files to /opt/sun/comms/messaging/config/legacy-config/

# bin/imsimta version
Oracle Communications Messaging Server 7u5-28.12 64bit (built May Nov 5 2012)
libimta.so 7u5-28.12 64bit (built 15:58:11, Nov 5 2012)
Using /opt/sun/comms/messaging/config/config.xml (not compiled)
Linux host1.example.com 2.6.39-100.5.1.el5uek #1 SMP Tue Mar 6 20:25:25 EST 2012 x86_64 x86_64 x86_64 GNU/Linux

See also: