You can export the following components from one TrueSight Network Automation system into an XML file that you can then import into another Network Automation system. You also can import components that you create manually.
- Combo groups
- Conditions
- Device security profiles
- Dynamic fields
- Global substitution parameters
- Keywords
- Policies
- Predefined jobs
- Roles
- Rules
- Rule sets
- Remote file servers
- Templates
This topic describes how to export and import components using a script.
Import and export scripts
The scripts are available in the bcan-import-export-v.r.mm.zip file in the BCAN_HOME\public\bmc\bca-networks\extras directory. When the file is unzipped, the scripts are in the bin subdirectory. The lib subdirectory contains the libraries needed to run the scripts.
Note
The string v.r.mm is a substitute for the current version of the Network Automation software.
Both Linux and Microsoft Windows scripts are available. For usage information, invoke any of the scripts with a -? option. This option displays the list of input parameters.
Note
- You can export and import components only between Network Automation application servers of the same version.
- Dependent components that you are importing should already exist in the Network Automation system. For more information, see Import dependencies.
Back to top
To export components using a script
Invoke the export.bat or export.sh command with the following options:
| |
|---|
| |
-component component_name | Specifies the component to export: Valid values: - ComboGroups
- Conditions
- DeviceSecurityProfiles
- DynamicTypes
- Keywords
- Policies
- PredefinedJobs
- RemoteFileServers
- Roles
- Rules
- RuleSets
- SubstitutionParameters
- TemplateGroups
|
| Specifies the name of the export file |
| (Optional) Specifies the character encoding to be used to when creating the output file during export Valid values: UTF-16, UTF-8 (default)
Note: For UTF-8, the file should not contain Byte Order Mark (BOM) encoding because the Java APIs do not handle UTF-8 with BOM-encoded files. |
| (Optional) Specifies the name of the component to export
You can use wildcards; for example, Bronze group. |
| Specifies the Network Automation server password |
| Specifies the Network Automation server URL in the following format: https://<server>:<port> |
| Specifies the Network Automation server user name |
| Prints detailed error stack trace |
Import dependencies
A component might use or have dependency on other underlying components. Before you import a component, ensure that you import its underlying components. For more information about considerations and conditions while importing components, see the following table.
| Dependency description and other conditions |
|---|
| Components - Groups – The groups which comprise the combo group must be present in the destination system.
- Dynamic fields – The dynamic fields associated with the combo group must be present in the destination system.
|
| Components - Keywords – The keywords used by the condition must be present in the destination system.
- Devices – The devices for which the condition is applicable must be present in the destination system.
- Groups – The groups for which the condition is applicable must be present in the destination system.
- Realms – The realms for which the condition is applicable must be present in the destination system.
- Dynamic fields – The dynamic fields associated with the condition must be present in the destination system.
|
| No dependencies Condition - If a device security profile with the same name already exists on the destination system, that device security profile is overwritten.
|
| These dependencies are applicable for only the configuration profiled (CAP) dynamic fields: - Devices – The devices with which the dynamic fields are associated must be present in the destination system.
- Groups – The groups with which the dynamic fields are associated must be present in the destination system.
- Realms – The realms with which the dynamic fields are associated must be present in the destination system
|
Global substitution parameters | Component - Dynamic fields – The dynamic fields associated with the global substitution parameter must be present in the destination system.
|
| Component - Dynamic fields – The dynamic fields associated with the keyword must be present in the destination system.
|
| Components - Devices – The devices for which the policy is applicable must be present in the destination system.
- Groups – The groups for which the policy is applicable must be present in the destination system.
- Realms – The realms for which the policy is applicable must be present in the destination system.
- Keywords – The keywords being used by the policy must be present in the destination system.
- Conditions – The conditions being used by the policy must be present in the destination system.
- Users – If a notification is to be sent to a set of users, the same set of users must be present in the destination system.
|
| Components - Devices – The devices on which the predefined job needs to be run must be present in the destination system.
- Groups – The groups on which the predefined job needs to be run must be present in the destination system.
- Realms – The realms on which the predefined job needs to be run must be present in the destination system. If you are importing a predefined job containing a span action with group as the span and the system contains groups with the same name in multiple realms, you must specify the realm name under the spanParams tag in the XML file being imported. If you do not specify a realm, a random group (as a span) gets associated with the job.
- Rules – The rules being used in the predefined job actions must be present in the destination system.
- Templates – When importing a predefined job containing a template (for example, Deploy to Active), the destination system should already have a template by that name. Alternatively, you can import the template, but import it prior to importing the predefined job, or add the template to the XML file that is being imported and place it before the predefined job.
|
| Components - Dynamic fields – The dynamic fields associated with the role must be present in the destination system.
- Custom action adpaters – The custom action adapter (if used) in the role must be present in the destination system.
Conditions - No users are associated with roles while importing or exporting roles.
- You cannot add a new root role, or modify a role to be the root role while importing.
- You can modify only the dynamic fields of an Administrator role while importing.
- If a role with the same name already exists on the destination system, that role is overwritten.
The user who is importing a new role or the changes to an existing role must have rights to add or edit such a role.
If you want to change the rights assigned to a role in the XML file, see the Javadoc documentation for the values that you can pass in the XML file. Note that you must log on to access the documentation. You must log in or register to view this page Click here to download it.
|
| Components - Rule sets – The rule set which the rule belongs to must be present and enabled in the destination system.
- Device types – The device types for which the rule is applicable must be enabled in the destination system.
- Devices – The devices for which the rule is applicable must be present in the destination system.
- Groups – The groups for which the rule is applicable must be present in the destination system.
- Relams – The realms for which the rule is applicable must be present in the destination system.
- Dynamic fields – The dynamic fields associated with the rule must be present in the destination system.
|
| Components - Devices – The devices for which the rule set is applicable must be present in the destination system.
- Groups – The groups for which the rule set is applicable must be present in the destination system.
- Realms – The realms for which the rule set is applicable must be present in the destination system.
|
| Component - Dynamic fields – The dynamic fields associated with the remote file server must be present in the destination system.
|
| Component - Dynamic fields – The dynamic fields associated with the template must be present in the destination system.
|
To import components using a script
Invoke the import.bat or import.sh command with the following syntax and options:
import options filename [filename ...]
Note
If you import components that already exist, Network Automation deletes the existing component and adds the new one.
Network Automation does not merge the data of the existing component and the new component.
The following options are available for this command:
| |
|---|
| |
| (Optional) Specifies the character encoding to be used to read the input files during import Valid values: UTF-16, UTF-8 (default)
Note: For UTF-8, the file should not contain BOM encoding because the Java APIs do not handle UTF-8 with BOM-encoded files. |
| Specifies the Network Automation server password |
| (Optional) Specifies the import scope that designates the components to import Valid values: - all – Default
- new – Only imports components that are not already in the database
- existing – Reimports components and overwrites those already in the database
|
| Specifies the Network Automation server URL in the following format: https://<server>:<port> |
| Specifies the Network Automation server user name |
| Prints detailed error stack trace |
Replace filename with the names of one or more XML files that were exported from a Network Automation server.
These file names can contain absolute or relative paths. If a file name contains a blank space, it must be enclosed in double quotation marks (").
You can also use wildcards (for example, *myfile.xml*).
Back to top
Exporting-and-importing-components-using-APIs