Configuring the PowerShell adapter

The PowerShell actor adapter supports empty and multiple configurations. The PowerShell adapter considers the target as localhost and executes the command on the command line under the following conditions:

The adapter has an empty configuration, and the dynamic target is not defined
You do not define a dynamic target, and the configuration has a blank target or no target
You define a dynamic target and do not specify the host name

Adapter type: bmc-adapter-microsoft-windows-powershell-actor_vv.rr.nn

Default name: MicrosoftPowerShell

To configure the PowerShell adapter, see Configuring base adapters.

BMC recommends that you do not use empty elements in an adapter configuration because they might cause errors.

Prerequisites for the PowerShell adapter remoting feature:

Set <powershell-version> to 2.0.
Install PowerShell version 2.0 on the peer on which the adapter is enabled. For more information about PowerShell remoting, go to http://technet.microsoft.com/en-us/magazine/ff700227.aspx

The following table describes the adapter configuration elements for the PowerShell adapter that you can specify by 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.

Configuration node elements for the PowerShell adapter

The following figure shows an XML sample for the PowerShell adapter configuration.

XML sample of the PowerShell adapter configuration

<config>
     <target>host1</target>
     <user-name>user1</user-name>
     <password encryption-type="Plain">pass1</password>
     <powershell-version>2.0</powershell-version>
     <use-userprofile>true</use-userprofile>
     <script-file-path>local</script-file-path>
     <character-set>gb18030</character-set>
     <logon-with-user-credentials>true</logon-with-user-credentials>
</config>

The following figure shows an XML sample for a PowerShell adapter configuration with the <powershell-consolefile> tag.

XML sample of the PowerShell adapter configuration with <powershell-consolefile> tag

<config>
<target>host1</target>
<user-name>user1</user-name>
<password encryption-type="Plain">pass1</password>
<powershell-consolefile>
Microsoft.EnterpriseManagement.OperationsManager.ClientShell.Console.psc1
</powershell-consolefile>
</config>

The following figure shows an XML sample for the PowerShell adapter configuration when the remoting feature is enabled.

XML sample of the PowerShell adapter configuration when the remoting feature is enabled

<config>
<target>10.128.249.29</target>
<user-name>bmcadmin</user-name>
<password encryption-type="Plain">asdfgh@123</password>
<powershell-version>2.0</powershell-version>
<use-userprofile>false</use-userprofile>
<script-file-path>local</script-file-path>
<enable-psremoting>true</enable-psremoting>
</config>

The following figure shows an XML sample for the PowerShell adapter configuration when the <impersonate-user> element is set to true.

XML sample for the PowerShell adapter configuration when the Impersonate User is set to true.

<config>
       <target>vm-yyy-w2k</target>
       <user-name>domain.local\domainuser1</user-name>
       <password>password</password>
       <protocol>default</protocol>
   <service-launch-mode>64bit</service-launch-mode>
   <logon-with-user-credentials>true</logon-with-user-credentials>
   <impersonate-user>true</impersonate-user>
</config>

The following figure shows an XML sample for the PowerShell adapter configuration when the <service-launch-mode> is 64-bit.

XML sample for the PowerShell adapter configuration when the <service-launch-mode> is 64-bit

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 BMC Atrium Orchestrator Platform version 7.8 or later to use the custom logging feature. These parameters will be ignored in earlier versions of BMC Atrium Orchestrator Platform.

These parameters are available with supported adapter versions. See your adapter 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

Configuring the PowerShell adapter

Enabling custom logging

On this page