Configuring the Solaris Zones adapter
You can create an adapter in Grid Manager by defining a configuration. This configuration provides information about how TrueSight Orchestration interacts with Solaris Zones.
While each adapter must have a unique name, you can create multiple adapters with the same adapter type to allow for different configuration properties.
Note
The default name for the actor adapter is SolarisZoneActorAdapter.
To create an actor adapter configuration
- Log on to the TrueSight Orchestration Grid Manager.
- To access the adapters page, click the Manage tab and then click the Adapters tab.
- In the Adapters in Repository list, select the check box corresponding to the type of adapter to be added.
- Select bmc-adapter-solaris-zones-actor to add an actor adapter to the Grid.
- To include the adapter in the Adapters on Grid list, click Add to Grid.
- Click Configure corresponding to the newly added adapter.
- On the Add an Adapter Configuration page, perform the following sub-steps to configure the adapter by using the form view, or jump to step 8to configure the adapter by using the XML view:
Enter a name for the adapter.
- Specify a description for the adapter.
- Under Properties, enter or select values for the configuration elements.
The configuration elements for the adapter are described in the following table. Include all required elements indicated with an asterisk (*). - Click OK.
- (optional) Configure the adapter in the XML view using the following substeps:
- Specify a name for the adapter.
- Specify a description for the adapter.
- Click Switch to XML View.
- On the Warning message that appears, click Switch View.
In the Properties text box, enter the adapter configuration properties in XML format, including all required elements.
XML sample for configuring the actor adapter<config> <target>vm-sol-abc</target> <user-name>admin</user-name> <password encryption type ="Plain">admin1</password> <port>9080</port> <prompt>#</prompt> <timeout-secs>60</timeout-secs> <known-hosts-config>admin/ssh/known_hosts</known-hosts-config> <allow-unknown-hosts>false</allow-unknown-hosts> <preferred-pk-algorithm>ssh-rsa</preferred-pk-algorithm> <establish-connection-timeout-secs>100 </establish-connection-timeout-secs> <network-environment>true</network-environment> <line-termination>&#A;</line-termination> </config>
Click OK.
- On the warning message that appears, click Save.
This saves the adapter configuration with settings in the XML view permanently. The newly configured adapter is now listed in the Adapters on Grid list.
The following table describes the adapter configuration elements and attributes that you can specify using the form view, XML view, or both. You cannot use the form view to configure elements and attributes that do not have an entry in the _UI label_column.
Note
Switching to the XML view to specify configuration elements and attributes means that you cannot thereafter use the form for modifying the adapter configuration.
Node elements and attributes required to configure the actor adapter
UI Label | Element | Description | Required |
---|---|---|---|
Target |
| Specifies the Solaris computer on which the Global Zone is running | Yes |
User Name |
| Specifies the user name for authentication on the Solaris computer | Yes |
Password |
| Specifies the password corresponding to the specified user-name | No |
Encryption Type |
| Indicates whether the password specified is encrypted; is an attribute of the <password> element, not an element itself | No |
Port |
| Specifies the SSH port on which the SSH service is running on the Solaris computer | No |
Private Key File |
| Specifies the path and file name of the local SSH key file | Conditional |
Pass Phrase |
| Specifies the passphrase used to protect the private key file | Conditional |
Encryption Type |
| Indicates whether the passphrase specified is encrypted; is an attribute of the <pass-phrase> element, not an element itself | No |
Prompt |
| Specifies the console prompt displayed when the Solaris computer is waiting for a command | Conditional |
Timeout Secs |
| Specifies the time, in seconds, to wait for the expected prompt to be returned by the Solaris computer | No |
Known Hosts Config |
| Specifies the location of the local known_hosts file | No |
Allow Unknown Hosts |
| Indicates whether a connection should continue if the key verification process fails
| No |
Preffered Pk Algorithm |
| Specifies the algorithm for encrypting the public key
| No |
Establish Connection Timeout Secs |
| Specifies the time, in seconds, to wait for user authentication on the Solaris server | No |
Network Environment |
| Creates an extra channel session for use with Oracle Solaris 9
| No |
Line Termination |
| Specifies the line termination character used with the SSH command | No |
Enabling custom logging
To enable custom logging for the adapter, you must specify a log file name. You can also provide additional parameters for logging.
Note
You must be using TrueSight Orchestration version 8.1 or later to use the custom logging feature. These parameters will be ignored in earlier versions of TrueSight Orchestration Platform.
These parameters are available with supported adapter versions. See TrueSight Orchestration Content documentation for details.
- Log File Name: Provide a name for the log file.
This file will be stored in the AO_HOME/tomcat/logs directory. If Log File Max Backup Index value is greater than 0, the log file name is suffixed with the backup index. For example, if the parameter value is a.log, backup log files will have names, such as a.log.1, a.log.2. - Log File Size: Specify a size limit for the log file.
If the value specified for Log File Max Backup Index is greater than 0, when the specified size is reached, the current file is renamed with the suffix .1. Otherwise, the log file will be reset and over-written. The default value is 10MB. The available units are KiloBytes (KB), MegaBytes (MB) or GigaBytes (GB). - Log File Max Backup Index: Enter the maximum number of backup files allowed. The default value is 10.
- Log File Append: Select this option to append new log information to the existing information in the file. If unselected, the file will be overwritten with new log information.
Log Level: Enter the logging level using one of the following choices:
Logging level
Description
DEBUG
The most detailed logging level; logs low-level messages, normal execution, recoverable erroneous conditions, and unrecoverable erroneous conditions
INFO
(default)
Logs normal execution, recoverable erroneous conditions, and unrecoverable erroneous conditions
WARN
Logs recoverable erroneous conditions and unrecoverable erroneous conditions
ERROR
The least detailed logging level; logs only error conditions that are not usually recoverable
Encrypting an element's contents
You can add the attribute secure="true"
to an XML adapter element XML view to ensure that the element's contents is encrypted when displayed.
Note
You must be using TrueSight Orchestration Platform version 8.1 or later to use this encryption attribute.
Comments
Log in or register to comment.