×
 
 
  •  
$helper.renderConfluenceMacro('{bmc-global-announcement:$space.key}')
BMC Atrium Orchestrator Content 20.15.03 ... Application adapters Solaris Zones adapter

Configuring the Solaris Zones adapter

You can create an adapter in Grid Manager by defining a configuration. This configuration provides information about how BMC Atrium Orchestrator 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

  1. Log on to the BMC Atrium Orchestrator Grid Manager.
  2. To access the adapters page, click the Manage tab and then click the Adapters tab.
  3. In the Adapters in Repository list, select the check box corresponding to the type of adapter to be added.
  4. Select bmc-adapter-solaris-zones-actor to add an actor adapter to the Grid.
  5. To include the adapter in the Adapters on Grid list, click Add to Grid.
  6.   Click Configure corresponding to the newly added adapter.
  7. 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:

    1.  Enter a name for the adapter.

    2. Specify a description for the adapter.
    3. 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 (*).
    4. Click OK.
  8. (optional) Configure the adapter in the XML view using the following substeps:
    1. Specify a name for the adapter.
    2. Specify a description for the adapter.
    3. Click Switch to XML View.
    4. On the Warning message that appears, click Switch View.

    5. 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>

    6. Click OK.

    7. 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

<target>

Specifies the Solaris computer on which the Global Zone is running

Yes

User Name

<user-nam>

Specifies the user name for authentication on the Solaris computer

Yes

Password

<password>

Specifies the password corresponding to the specified user-name

No

Encryption Type

<encryption-type>

Indicates whether the password specified is encrypted; is an attribute of the <password> element, not an element itself
Valid values: Base64, Plain (default)

No

Port

<port>

Specifies the SSH port on which the SSH service is running on the Solaris computer

No

Private Key File

<private-key-file>

Specifies the path and file name of the local SSH key file
The path and file must exist on the peer where the adapter is enabled.

Conditional
Required if the password element is not specified. If both the password and the private-key-file element are specified, the private-key-file element is used and the password is ignored

Pass Phrase

<pass-phrase>

Specifies the pass phrase used to protect the private key file

Conditional
Required if the private-key-file element is specified.

Encryption Type

<encryption-type>

Indicates whether the pass phrase specified is encrypted; is an attribute of the <pass-phrase> element, not an element itself
Valid values: Base64, Plain (default)

No

Prompt

<prompt>

Specifies the console prompt displayed when the Solaris computer is waiting for a command
This element contains the terminating string, typically ending with a $, >, or # character.
Each command executes in a separate session, as if each command is executing in a new command shell. The prompt indicates the completion of the command execution. The prompt element must be unique, and it should not match the potential command output to avoid parsing issues.

Conditional
Required for using the proxy command feature

Timeout Secs

<timeout-secs>

Specifies the time, in seconds, to wait for the expected prompt to be returned by the Solaris computer
If the expected prompt is not returned before the specified value in the element has elapsed, an error message is returned. The default value for this element is 60 seconds.

No

Known Hosts Config

<known-hosts-config>

Specifies the location of the local known_hosts file
The known_hosts file is used to perform key verification. The default value for this element is home_dir/.ssh/known_hosts.

No

Allow Unknown Hosts

<allow-unknown-hosts>

Indicates whether a connection should continue if the key verification process fails
The valid values for this element are:

  • true = (default) adapter maintains the connection to an unknown or mismatched system
  • false = adapter terminates the connection to an unknown or mismatched system and returns an error in the adapter response

No

Preffered Pk Algorithm

<preferred-pkalgorithm>

Specifies the algorithm for encrypting the public key
The valid values for this element are:

  • ssh-dss
  • ssh-rsa (default)

No

Establish Connection Timeout Secs

<establish-connection-timeout-secs>

Specifies the time, in seconds, to wait for user authentication on the Solaris server
If the authentication process is not successful within this interval, the adapter returns an error message. The default value for this element is 60 seconds.

No

Network Environment

<network-environment>

Creates an extra channel session for use with Oracle Solaris 9
The valid values for this element are:

  • true
  • false (default)
    To connect to network devices, you must set this element to false.

No

Line Termination

<line-termination>

Specifies the line termination character used with the SSH command
The value for this element is hexadecimal. For example, the hexadecimal value for \r is &#D and for{{\n}} is &#A;.
If you do not specify this element, the adapter does not assign any line termination character.

No

Was this page helpful? Yes No Submitting... Thank you
Last modified by Shweta Hardikar on Dec 01, 2015
solaris_zones configuration

Comments

Log in or register to comment.

Supported version of Solaris
Module for the Solaris Zones adapter
© Copyright 2024 BMC Software, Inc.
Legal notices

Powered by Atlassian Confluence and Scroll Viewport

© Copyright 2005-2024 BMC Software, Inc. Use of this site signifies your acceptance of BMC’s Terms of Use . BMC, the BMC logo, and other BMC marks are assets of BMC Software, Inc. These trademarks are registered and may be registered in the U.S. and in other countries.