CA Technologies

ixutil Command Line Reference


1.0 IXUTIL Import/Export Utility
1.1 IXUTIL Files
1.2 Data File Types
1.3 IXUTIL Export Syntax
1.4 IXUTIL Import Syntax
1.5 Object Syntax
1.6 Object Syntax Rules and Considerations
1.7 IXUTIL Parameters
1.8 Object Modification
  1.8.1 Object Modification Considerations
  1.8.2 Date Last Modified Conditions
1.9 Export and Import All Objects
1.10 Preservation of Inheritance
1.11 Export and Import Events, Rules, and Actions
1.12 Export and Import Configurations
1.13 Export and Import Services
1.14 Export and Import Report Data
1.15 Export and Import Business Units
1.16 Import CA Workflow Forms into the Form Designer
1.17 Export and Import Form Designer Forms
1.18 Export and Import Form Designer Forms Associated to Service Option Elements
1.19 Export and Import Policies


1.0 IXUTIL Import/Export Utility

IXUTIL is an importing and exporting command line utility that allows the preservation and migration of CA Service Catalog data between systems. For example, you can export offerings (services) from a CA Service Catalog Release 12.7 system and import them as services into a CA Service Catalog Release 12.8 system, using the same XML structure.

You can use IXUTIL to export and import new and updated objects from one CA Service Catalog instance to another CA Service Catalog instance. This migration is primarily intended for both of the following:

IXUTIL does not import or export images of offerings because of the variation of the image file path names on the source and target computers. If you want to retain such images, you must copy and paste them manually, after the initial migration is complete.

Note: Use the CA Workflow IDE, not IXUTIL, to export and import CA Workflow actors and process definitions between systems running the same release of CA Service Catalog; for details, see the CA Workflow IDE online help.

Important! CA Workflow is no longer being enhanced, and its maintenance and technical support are scheduled to be discontinued as of December 31, 2013. Therefore, we strongly recommend using CA Process Automation as your process automation tool.

1.1 IXUTIL Files

For Windows, the import/export utility file (ixutil.bat) is located in the USM_HOME\scripts folder.

USM_HOME specifies the CA Service Catalog installation directory on this computer. For 32-bit computers, the default path name is C:\Program Files\CA\Service Catalog. For 64-bit computers, the default path name is C:\Program Files (x86)\CA\Service Catalog.

You can configure IXUTIL by using the ixutil.cfg properties file located in the USM_HOME\scripts folder. This file controls import and export rules, default export file format, error log file and so on. The ixutil.cfg file contains comments and details about each configurable parameter.

Log messages from IXUTIL appear in the USM_HOME\logs\install\ixutil.log file.

1.2 Data File Types

For most object types, IXUTIL exports the data in a proprietary XML format, and you must use the same XML format when importing. You can determine the correct XML formats for each object type by examining an exported XML file.

IXUTIL lets you import and export the following types of data:

1.3 IXUTIL Export Syntax

The export syntax for using the ixutil.bat (Windows) command is as follows:

ixutil export object –f file –format xml object-specific parameters

1.4 IXUTIL Import Syntax

The import syntax for using the ixutil.bat (Windows) command is as follows:

ixutil import object –f file –format xml object-specific parameters

1.5 Object Syntax

In most cases, you must import or export each type of object in its own separate command, as shown in the following list. For example, you import services, and events in three separate commands. You cannot combine two or more types of objects in a single import command. An exception is the service offering option that contains service option group and service option element as noted in the following list.

Note: You do not literally enter the brackets around these options; the brackets are in this list for readability only.

Configurations

ixutil import configuration [-f file] [-format xml] [-businessunit id] [-group name] [-contentpack name]
ixutil export configuration [-f file] [-format xml] [-businessunit id] [-group name]

Events

ixutil import event [-f file] [-format xml] [-event name] [-rule name] [-action name] [-contentpack name] [-disable] [-disallow_duplicates]
ixutil export event [-f file] [-format xml] [-event name] [-rule name] [-action name]

Forms

ixutil import form [-f file] [-format xml] [-cawf -businessunit id] [-contentpack name] [-modified_only] [-disallow_duplicates]
ixutil export form [-f file] [-format xml] [-folder foldername][-form formname] [-businessunit id]

Services

ixutil import service [-f file] [-businessunit id] [-include_incomplete_sub] [-include_cmdb_ci_mapping] [-include_permissions] [-include_request_sla] [-inlcude_service_hour] [-include_resource_type] [-include_application_metric] [-contentpack name] [-modified_only] [-include_associated_policies_and_actions] [-disallow_duplicates] [-include_translation] [-merge_translation]
ixutil export service [-f file] [-folder name] [-servicename name] [-businessunit id] [-include_forms] [-include_cmdb_ci_mapping] [-include_permissions] [-include_request_sla] [-include_service_hour] [-include_resource_type] [-include_application_metric] [-include_associated_policies_and_actions] [-include_translation] [-extract_translation]

Policies

ixutil import policy [-f file] [-format xml] [-businessunit id] [-disable] [-contentpack name]
ixutil export policy [-f file] [-format xml] [folder foldername[,foldername2]] [-policy policyname[,policyname2]] [-businessunit id]

Report Data

ixutil import report_data [-f file] [-format xml] [-folder name] [-contentpack name] [-disallow_duplicates]
ixutil export report_data [-f file] [-folder name(s)] [-id(s)]

Business Units

ixutil import businessunit [-f file] [-format xml] [-businessunit id]
ixutil export businessunit [-f file] [-businessunit id] 

1.6 Object Syntax Rules and Considerations

The following rules apply to the IXUTIL command line:

The following considerations apply to the IXUTIL command line:

1.7 IXUTIL Parameters

The following parameters are used for the IXUTIL command:

Use the form-related parameters to export and import CA Workflow forms and Form Designer forms. The following are the included parameters:

1.8 Object Modification

An object can be modified in the following ways:

Note: The consideration for object modifications and the conditions for date last modified are only required if the -modified_only parameter is specified. Refer to the description of -modified_only parameter in IXUTIL Parameters.

1.8.1 Object Modification Considerations

Consider the following information when you use IXUTIL for services, service options, and service option groups.

The term objects here means services, service option groups, and service option elements. As a best practice, do not modify objects directly on your production computer. Instead, always modify objects on your test computer first, test them thoroughly, and then export them to the production computer. If you do update objects on both the test and production computers and then export, you may accidentally overwrite changes or data on the production computer. You cannot merge changes between two same-named objects on the source and destination computers. The newer object always take precedence when you run IXUTIL.

The following considerations apply to services, service options, and service option groups objects:

1.8.2 Date Last Modified Conditions

The date last modified is updated under the following conditions:

1.9 Export and Import All Objects

You can export all objects to the target computer from an existing CA Service Catalog implementation. All the objects in the XML file are imported without any timestamps checks. Use the –modified_only parameter to view the previous behavior of IXUTIL. This parameter is basically introduced for backward compatibility. You can export all objects in the following ways:

1.10 Preservation of Inheritance

When you export services that contain service option groups, and service option elements from one business unit to another, inheritance is supported if you follow these rules. If you do not follow these rules, you can export the objects, but the inheritance is broken.

1.11 Export and Import Events, Rules, and Actions

You can use IXUTIL to export and import new and updated objects, including events, rules, and actions, from one computer to another. You can export and import services in the following cases:

Note: You can also use the Import Export Utility on the product UI to import and export configurations. The Import Export Utility provides a GUI to import and export configurations and other objects that is not present for Events.

Follow these steps:

  1. Open the CA Service Catalog command prompt on any CA Service Catalog computer.
  2. Navigate to the Scripts folder in the command prompt.
  3. Enter one or more of the following export commands on the source computer, as applicable:

    Refer to IXUTIL Parameters for more information on the parameters.

  4. Enter one or more of the following import commands on the target computer, as applicable:
  5. If you imported events, rules, or actions, restart the Windows service named CA CA Service Catalog. Restart this service on all CA Service Catalog computers in your environment.

    Important! If you import objects but do not restart the CA CA Service Catalog service on all CA Service Catalog computers, unpredictable results can occur.

  6. Log in to CA Service Catalog on the computer where you imported the objects.
  7. Click Administration, Tools, Events-Rules-Actions.

    The Event Types page appears.

  8. View the events, including the rules and actions. Verify that the Catalog system imported the objects as you wanted.
  9. Close the CA Service Catalog command prompt.

You have exported and imported events, rules, and actions.

1.12 Export and Import Configurations

You can use IXUTIL to export and import new and updated objects, including configuration objects, from one computer to another. You can export and import configurations in the following cases:

Note: You can also use the Import Export Utility on the product UI to import and export configurations. This utility provides a GUI for importing and exporting configurations and other objects.

Follow these steps:

  1. Open the CA Service Catalog command prompt on any CA Service Catalog computer.
  2. Navigate to the Scripts folder in the command prompt.
  3. Enter one or more of the following commands:
  4. Log in to CA Service Catalog on the computer where you imported the configurations. If you had imported configurations into a specific business unit, log in to the respective business unit.
  5. Click Catalog, Configuration, or Administration, Configuration, or Accounting, Configuration.
  6. Verify that CA Service Catalog imported the configurations as you want.
  7. Close the CA Service Catalog command prompt.

1.13 Export and Import Services

You can use IXUTIL to export and import new and updated objects, including service objects, from one computer to another. You can export and import services in the following cases:

Note: You can also use the Import Export Utility on the product UI to import and export services. This utility provides a GUI for importing and exporting services and other objects.

Follow these steps:

  1. Open the CA Service Catalog command prompt on any CA Service Catalog computer.
  2. Navigate to the Scripts folder in the command prompt.
  3. Enter one or more of the following commands:

    Refer to IXUTIL Parameters for more information on the parameters.

  4. Log in to CA Service Catalog on the computer where you imported the services. If you had imported services into a specific business unit, log in to the respective business unit..
  5. Click Catalog, Service Offerings.
  6. Verify the following:
  7. Close the CA Service Catalog command prompt.

1.14 Export and Import Report Data

You can use IXUTIL to export and import new and updated objects, including report data, from one computer to another. You can export and import report data in the following cases:

Note: You can also use the Import Export Utility on the product UI to import and export report data. This utility provides a GUI for importing and exporting report data and other objects.

Important! If you export report data objects that are based external data sources, verify that they are imported correctly on the target computer. To verify, review the ixutil log file in the USM_HOME\logs\install folder on the target computer. If necessary, recreate these report data objects on the target computer. For information about log files, including how to set the level of detail, see the Implementation Guide. For information about creating report data objects, see the Administration Guide.

Follow these steps:

  1. Open the CA Service Catalog command prompt on any CA Service Catalog computer.
  2. Navigate to the Scripts folder in the command prompt.
  3. Enter one or more of the following commands:

    Refer to IXUTIL Parameters for more information on the parameters.

  4. Log in to CA Service Catalog on the computer where you imported the report data. If you had imported report data into a specific business unit, log in to the respective business unit.
  5. Click Administration, Report Builder, Data Objects.
  6. Verify that the CA Service Catalog imported the Report Data as you want.
  7. Close the CA Service Catalog command prompt.

1.15 Export and Import Business Units

You can use IXUTIL to export and import new and updated objects, including business unit objects, from one computer to another. You can export and import business units in the following cases:

Note: You can also use the Import Export Utility on the product UI to import and export business units. This utility provides a GUI for importing and exporting business units and other objects.

Follow these steps:

  1. Open the CA Service Catalog command prompt on any CA Service Catalog computer.
  2. Navigate to the Scripts folder in the command prompt.
  3. Enter one or more of the following commands:

    Refer to IXUTIL Parameters for more information on the parameters.

  4. Log in to CA Service Catalog on the computer where you imported the business units. If you had imported business units into a specific business unit, log in to the respective business unit.
  5. Click Administration, Business Units.
  6. Verify that the CA Service Catalog imported the Business Units as you want.
  7. Close the CA Service Catalog command prompt.

1.16 Import CA Workflow Forms into the Form Designer

You can optionally import CA Workflow forms into the Form Designer. For example, you can do so if you upgraded from an earlier release of CA Service Catalog and have existing CA Workflow forms that you want to convert to Form Designer forms before continuing to use them in your services. Converting CA Workflow forms to Form Designer forms can be especially helpful as part of changing your process automation tool from CA Workflow to CA Process Automation.

Important! CA Workflow is no longer being enhanced, and its maintenance and technical support are scheduled to be discontinued as of December 31, 2013. Therefore, we strongly recommend using CA Process Automation as your process automation tool.

Follow these steps:

  1. In CA Workflow, select the form or forms that you want to import, and verify their path names.
  2. Verify that the forms are already present on the target computer; copy them manually to the target computer, if necessary.

    CA Workflow forms are stored as xml files. If you are using a filestore, they are stored in the FileStore\forms folder.

  3. On any CA Service Catalog computer, open a command prompt and enter the following command:
    ixutil import form -f {file|foldername} -format xml -cawf -businessunit id
    
  4. Verify that you can view and edit each imported form in the Form Designer.
  5. If necessary, make any formatting changes or any other required updates to the form.
  6. When the newly imported Form Designer form meets your requirements, update the service option to remove the CA Workflow form and to include the Form Designer form.

1.17 Export and Import Form Designer Forms

You can optionally export and import Form Designer forms alone, without any related service option elements, from a source (test) computer to a target (production) computer. Do so when you want to move and re-use one or more forms but not the related service option elements. You can export and import any of the following:

Follow these steps:

  1. On the source CA Service Catalog computer, export the form or forms by opening a command prompt and entering the following command:
  2. Navigate to the Scripts folder in the command prompt.
  3. Enter one or more of the following commands:
    ixutil export form -f file -format xml {-folder foldername|-form formname} -businessunit id
    

    The command runs and creates the XML export file at the location USM_HOME/build/install/view/exports. The file name is the name you specify using the -f file parameter described earlier.

    USM_HOME specifies the CA Service Catalog installation directory on this computer. For 32-bit computers, the default path name is C:\Program Files\CA\Service Catalog. For 64-bit computers, the default path name is C:\Program Files (x86)\CA\Service Catalog.

    Sample commands follow:

    ixutil export form -f file1.xml -format xml -form "Sample Form" -businessunit subBud
    
    ixutil export form -f file2.xml -format xml -folder "My Forms" -businessunit subBud
    
  4. Copy the exported XML file to the target CA Service Catalog computer.
  5. On the target CA Service Catalog computer, open a command prompt and enter the following command to import the XML file that you exported and copied in the previous steps:
    ixutil import form -f file -format xml -businessunit id
    

    The command runs and imports the form or forms and folders (if applicable) into the target (production or backup) computer, as follows:

    Note: The timestamp or the date last modified is no longer available. All that is part of XML file is imported. If you want the timestamp check then you should use the –modifed_only parameter.

    If you import a folder, then that folder, its forms, and its child folders are imported, with their folder structure maintained. However, both that folder and its parent folder from the source computer are attached to the root folder (named Forms) on the target computer. If the parent folder contains other child folders besides the one you exported, those other child folders are also exported and are included under the parent folder, with their folder structure maintained.

    For example, on the source computer, suppose Folder1 contains Folder2, and Folder2 contains Form1 and Form2. If you export folder 2 from the source computer and import it on target computer, then both Folder1 and Folder2 become root level folders on the target computer. Form1 and Form2 remain under Folder 2. Folder1 on the root folder includes and any forms or child folders that belong to it (except for Folder2).

  6. Verify that the forms appear correctly in the Form Designer; update them if necessary.
  7. Test the newly imported forms.
  8. Make the forms available for the users.

1.18 Export and Import Form Designer Forms Associated to Service Option Elements

You can export and import Form Designer forms to include them when exporting and importing service that contains service option elements (rate items), for example, when moving from source (test) to target (production) or from backup to restore.

In IXUTIL export commands for service that has service option elements, specify the –include_forms option to include the Form Designer forms (not CA Workflow forms) associated with the service option elements. The –include_forms option is not valid in IXUTIL import commands; the forms are included in the import automatically if they were included in the export.

Follow these steps:

  1. On the source CA Service Catalog computer, enter the following commands to export the folder structure for the forms from the source computer and import it on the target computer. If you do not want to export and import the folder structure, skip this step.
    ixutil export form -f file -format xml {-folder name|-form name} -businessunit id
    
    ixutil import form -f file -format xml -businessunit id
    

    For an explanation of the command options, see the descriptions of these commands in Import and Export Form Designer Forms.

  2. On the source CA Service Catalog computer, export the forms associated with the service option elements by opening a command prompt and entering the following command:
    ixutil export {service} -f file {-offering name|-folder name|-businessunit id} -include_forms other options
    

    Note: Service option elements are processed in IXUTIL export service commands only. Therefore, use –include_forms in IXUTIL export service commands only, as explained in this topic.

    The command runs and creates the XML export file at the location USM_HOME/build/install/view/exports. The file name is the name you specify using the -f file parameter.

    USM_HOME specifies the CA Service Catalog installation directory on this computer. For 32-bit computers, the default path name is C:\Program Files\CA\Service Catalog. For 64-bit computers, the default path name is C:\Program Files (x86)\CA\Service Catalog.

  3. Copy the exported XML file to the target CA Service Catalog computer.
  4. On the target CA Service Catalog computer, open a command prompt and enter the following command to import the forms:
    ixutil import {service} -f file other options
    

    If you specified service in the original export command, specify service in the corresponding import command.

  5. Verify that the forms appear correctly in the Form Designer; update them if necessary.
  6. Test the newly imported forms.
  7. Make the forms available for the users.

1.19 Export and Import Policies

The IXUTIL command line utility is an importing and exporting command line utility that allows the preservation and migration of CA Service Catalog data between computers. You can use IXUTIL to export and import new and updated objects, including policies, from one computer to another. You can export and import policies in the following cases:

Note: You can also use the Import Export Utility on the product UI to import and export policies. This utility provides a GUI for importing and exporting policies and other objects.

Follow these steps:

  1. Open the CA Service Catalog command prompt on any CA Service Catalog computer.
  2. Enter one or more of the following commands:

    Refer to IXUTIL Parameters for more information on the parameters.

  3. Log in to CA Service Catalog on the computer where you imported the policies. If you had imported policies into a specific business unit, log in to the respective business unit.
  4. Click Catalog, Policies.

    The Policy Builder main page appears.

  5. Expand the policy folders. Verify that the Catalog system imported the policy or policies as you want.
  6. Close the CA Service Catalog command prompt.