You can use the API to export components from one server and import them to another. The two servers must be running same version of TrueSight Network Automation.
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.
|
Import and export APIs
The ImportExportService class provides services to execute export and import of TrueSight Network Automation components.
The Web Service Definition Language (WSDL) URL for this service has the following syntax:
https://SERVER:PORT/bca-networks/services/ImportExportService?wsdl
Note
In the exported XML, the component attributes are embedded in CDATA sections if the attribute value for a particular component instance is detected to contain embedded XML metacharacters (for example, < or > character).
The following table lists the methods that are available:
| |
|---|
| Exports all combo groups from database to XML data. |
| Exports all conditions from database to XML data. |
exportContainerBlueprints() | Exports all container blueprints from database to XML data. |
| Exports all containers from database to XML data. |
exportDeviceSecurityProfiles() | Exports device security profiles (DSP) from database to XML. |
| Exports dynamic fields from database to XML. |
| Exports all keywords from database to XML data. |
| Exports all pod blueprints from database to XML data. |
| Exports all pods from database to XML data. |
| Exports all policies from database to XML data. |
| Exports predefined jobs from database to XML data. |
exportRemoteFileServers() | Exports remote file servers from database to XML data. |
| Exports roles from database to XML data. |
| Exports rules from database to XML data. |
| Exports rule sets from database to XML data.
The XML schema being used for the rule set XML files includes a full representation of each rule and its attributes within the rule set. |
exportSubstitutionParameters() | Exports global substitution parameters from database to XML data. |
| Exports template groups from database to XML data. |
| Imports any of the components that can be exported using the methods listed above into the TrueSight Network Automation database.
Whenever a new component is added or an existing component is modified during import, an event is logged into the event log. |
Exporting-and-importing-components-using-a-script