Module for the BMC Network Automation adapter
Each command supported by the application adapter has a corresponding process in the adapter module. Top-level processes perform high-level functions and call specialized processes in subdirectories. Each subdirectory contains process directories that correspond to the operation type for that command.
Top-level processes
The top-level processes perform high-level functions and call specialized processes in the subdirectories of the v5.2, v5.3, v5.4, v8.1, and v8.2 version directories.
The top-level processes in the Project Explorer window execute the following version-specific BMC Network Automation processes:
- Create Items
- Find Items
- Update Items
- Perform Operations
The following table lists the functional processes available for the top-level processes.
Top-level process | Functional process | Item type | Compatible with version |
---|---|---|---|
Create Items | Add Substitution Parameter | addSubstitutionParameter | 5.2, 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Find Items | Get Configuration | getConfiguration | 5.2, 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Find Items | Get Devices | getDevices | 5.2, 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Find Items | Get Span Action Results | getSpanActionResults | 5.2, 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Find Items | Get Job Approval Types | getJobApprovalTypes | 5.2, 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Find Items | Retrieve Job Status by JobID | retrieveJobStatusByJobID | 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Find Items | Get Simple Groups | getSimpleGroups | 5.2, 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Find Items | Get Substitution Parameter By Name | getSubstitutionParameterByName | 5.2, 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Find Items | Get Template Group By Name | getTemplateGroupByName | 5.2, 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Find Items | Get All Predefined Job Names | getAllPredefinedJobNames | 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Find Items | Get Predefined Job Names | getPredefinedJobNames | 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Find Items | Get Predefined Job Parameter Types | getPredefinedJobParameterTypes | 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Find Items | Get All Shared Runtime Parameters | getAllSharedRuntimeParameters | 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Find Items | Get All Firewall Rules | getAllFirewallRules | 8.1.01, 8.2, 8.3 |
Update Items | Modify Substitution Parameter | modifySubstitutionParameter | 5.2, 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Update Items | Modify Substitution Parameter | modifySubstitutionParameter | 5.2, 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Update Items | Modify Template Group | modifyTemplateGroup | 5.2, 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Update Items | Modify Template Group | modifyTemplateGroup | 5.2, 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Update Items | Overwrite Firewall Rules | overwriteFirewallRules | 8.1.01, 8.2, 8.3 |
Update Items | Replace Firewall Rules | repalceFirewallRules | 8.2, 8.3 |
Perform Operations | Approve by Change ID | approveByChangeID | 5.2, 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Perform Operations | Perform External Approval | performExternalApproval | 5.2, 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Perform Operations | Login | login | 5.2, 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Perform Operations | Logout | logout | 5.2, 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Perform Operations | Perform Backup | performBackup | 5.2, 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Perform Operations | Perform Custom Action | performCustomAction | 5.2, 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Perform Operations | Mark as Trusted by Config Date | markAsTrustedByConfigDate | 5.2, 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Perform Operations | Merge by Config Type | mergeByConfigType | 5.2, 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Perform Operations | Merge Compliant All Assigned | mergeCompliantAllAssigned | 5.2, 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Perform Operations | Send Job Summary Report Email | sendJobSummaryReportEmail | 5.2, 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Perform Operations | Log Critical Event | logCriticalEvent | 5.2, 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Perform Operations | Log Info Event | logInfoEvent | 5.2, 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Perform Operations | Log Major Event | logMajorEvent | 5.2, 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Perform Operations | Log Minor Event | logMinorEvent | 5.2, 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Perform Operations | Log Warning Event | logWarningEvent | 5.2, 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Perform Operations | Commit | commit | 5.2, 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Perform Operations | Restore by Template Group | restoreByTemplateGroup | 5.2, 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Perform Operations | Merge by Adhoc Template | mergeByAdhocTemplate | 5.2, 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Perform Operations | Merge by Template Group | mergeByTemplateGroup | 5.2, 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Perform Operations | Merge Compliant by Rule | mergeCompliantByRule | 5.2, 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Perform Operations | Merge Compliant by Rule Set | mergeCompliantByRuleSet | 5.2, 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Perform Operations | Validate Predefined Job Parameters | validatePredefinedJobParameters | 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Perform Operations | Submit Job | submitJob | 5.3, 5.4, 8.1, 8.1.01, 8.2, 8.3 |
Setup_Validation directory
The processes in the Setup_Validation directory contain sample values for request elements. You can change these sample values quickly to reflect the values in your environment. A process is provided to test each supported method of executing operations in BMC Network Automation.
Utilities directory
The Utilities directory contains helper and constructor processes. The functional processes require complex XML inputs. You can generate these complex XML inputs using the constructor processes in the Utilities directory.
Version directories
The v5.2, v5.3, v5.4, v8.1, and v8.2 directories contain functional processes specific to a version of BMC Network Automation. A process is available for each supported operation. Processes are grouped in subdirectories based on the type of the operation.
In the v5.2 directory, the functional processes are grouped as follows:
- Authentication
- Device_Information
- Events
- Jobs
- Reports
In the v5.3 directory, the functional processes are grouped as Devices and Predefined_Jobs.
In the v5.4 directory, the functional processes are grouped as Predefined_Jobs.
In the v8.1 directory, the functional processes are grouped as Firewall_Rules.
In the v8.2 directory, the functional processes are grouped as Security_Services.
The following table shows the compatibility of processes in version-specific directories with BMC BladeLogic Network Automation and BMC Network Automation:
Version Number directory | Are processes in the Version Number directory compatible with BNA version 5.2? | Are processes in the Version Number directory compatible with BNA version 5.3? | Are processes in the Version Number directory compatible with BNA version 5.4? | Are processes in the Version Number directory compatible with BNA version 8.1 and 8.1.01? | Are processes in the Version Number directory compatible with BNA version 8.2 and 8.3? |
---|---|---|---|---|---|
v5.2 | Yes | Yes | Yes | Yes | Yes |
v5.3 | No | Yes | Yes | Yes | Yes |
v5.4 | No | No | Yes | Yes | Yes |
v8.1 | No | No | No | Yes | Yes |
v8.2 | No | No | No | No | Yes |
Process inputs
The following table describes the input elements used by a process in the adapter module.
Inputs | Definition | Required |
---|---|---|
| Specifies the name of the adapter that handles the request | No |
| Contains the | Yes |
| Contains the elements needed for the adapter to connect
| No |
The following table describes the <connection parameters>
elements used by a process in the adapter module:
Element | Definition | Required |
---|---|---|
| Specifies the URL for the remote SOAP service
| Conditional; required if not specified in the request |
| Specifies the user name for the BMC Network Automation server authentication | Conditional; required if not specified in the request |
| Specifies the password for the user name specified | Conditional; required if not specified in the request |
| Specifies the SOAP version to use | Conditional; required if not specified in the request |
The following figure shows an XML sample for specifying <connection parameters>
at run time.
XML sample for specifying <connection parameters>
at run time
<connection-parameters>
<soap-version>1.1</soap-version>
<soap-url>https://s-17157:9443</soap-url>
<username>sysadmin</username>
<password>bmcadmin</password>
</connection-parameters>
Comments
Log in or register to comment.