PowerShell adapter module

The PowerShell adapter process is a part of AutoPilot AD-Utility module and is bundled under the terminal folder of the AD-Utility module.

The following table describes the process inputs for the PowerShell adapter.

PowerShell adapter process inputs

Input

Description

<adapter name>

Specifies the name of the adapter to be used for this process

Default name: MicrosoftPowerShell

<target>

Specifies the fully-qualified host name or IP address of the remote or the local computer

<command>

Specifies the PowerShell command to be executed, including arguments

<command encryption type>

Specifies the method of encryption used for the specified command value

Valid values: Base64, Plain

<command timeout>

Specifies the time, in seconds, allotted to complete the execution of the command

<host name>

Contains the host name or the IP address of the remote or local computer

If this element is absent, the target details from the adapter configuration are used.

<user name>

Contains the user name to be used for authentication on the remote host

<password>

Contains the password corresponding to the specified user name for authentication on the remote host

You can specify any special characters in the password.

<password encryption type>

Specifies the method of encryption used for the password provided

Valid values: Base64, Plain

<version>

Specifies the version of PowerShell on which the command is to be executed

Valid values:

  • 1.0
  • 2.0
  • 3.0
  • 4.0

<use user profile>

Specifies whether the user profile is to be loaded

Valid values: true, false

<console file>

Specifies the PowerShell console file to be loaded

<character-set>

Specifies the supporting CharSet

Also called character set, it includes identifiers describing a series of universal characters.

Note: The locale and character set of the target computer must be compatible with the character set provided in the <character-set> element to get the desired results.

<enable-psremoting>

Specifies whether to enable the remoting feature of PowerShell version 2.0

Valid values: true, false (default)

Notes

<log-on-with-user-credentials>

Starts a service on the remote computer

  • Set <logon-with-user-credentials> to true to start the remote service using the credentials specified in the adapter configuration.
  • Set <logon-with-user-credentials> to false, to start the remote service using the SYSTEM credentials on the remote server.

    Valid values: true, false (default)

    Note

    To start a service on the remote computer, you must set the rights for the user name specified in <user-name> to Log on as a service. Use the Microsoft Windows Local Security Policy tool to set the user name rights.

<impersonate-user>

Specifies whether to enable the user impersonation and allow the specified user to execute tasks by using the security context of another user (For example, BAO service running under a user account)

For example, a service running as LocalSystem could access network resources by impersonating a specific user account. This account would have been configured with the necessary permissions to access a network resource, something the service would not be able to do otherwise.For more information about how user impersonation works, see Impersonation

If set to true, the Service Control Manager (SCM) API is invoked with the user specified in the adapter request or configuration.

By default, the xCmd utility runs under the security context of the BAO service running under a user account. When we specify <impersonate-user> as true, the SCM API is invoked with the user specified in the adapter request or configuration.

Valid values: true, false (default)

<service-launch-mode>

Specifies the mode to launch the xCommand service on a remote system

By default, the xCommand utility is launched on 32-bit mode.

Valid value: 64bit

Note

Specify 64bit only if you want to launch the xCommand service on a 64-bit image mode on the target system.

BMC recommends that you do not specify any value if 64-bit is not required as it can affect the time taken for the request to execute.

<redirect-error-to-success-output-stream>

Specifies whether to redirect the command output error stream to the success output stream

Valid values: true, false (default)

When specified as true, all PowerShell commands are redirected to the success output stream.

The PowerShell adapter uses the xCMD utility to connect to the Windows System remotely to perform PowerShell commands. Since the xCMD utility only consumes output streams, it fails to process the data written on error streams and the actual output is not processed by the xCMD utility and reports an error. This problem occurs while executing the PowerShell Module cmd-lets version 3.0 and later.

The following table describes the process output parameters for the PowerShell adapter.

PowerShell adapter outputs

Output Element

Description

adapter response

Contains the result returned from the adapter request

The contents of the response vary depending on the following conditions:

  • Version of PowerShell that is used
  • Whether enable-psremoting is enabled or not
Was this page helpful? Yes No Submitting... Thank you

Comments