remoteScript.WindowsSmb

Execute script on Windows host via the SMB2 protocol

Type hierarchy: remoteScript.WindowsSmb > remoteScript.BaseSmbHost > remoteScript.RemoteScript > xlrelease.PythonScript > xlrelease.BasePythonScript > udm.BaseConfigurationItem
Label: Windows (SMB)

Properties

Property Kind Description
customScriptTask xlrelease.CustomScriptTask (parent) Custom Script Task
script String Shell script to execute on the remote host
scriptIgnoreVariableInterpolation Boolean If disabled ‘${}’ placeholder will be replaced with variables defined in XLR. Variable interpolation is enabled by default.
remotePath String Path on the remote host where the script will be executed
output String Console output of the process
err String Error stream of the process
temporaryDirectoryPath String Directory in which temporary files are stored. This directory will be cleaned up when the connection is closed.
jumpstation remoteScript.Jumpstation Jumpstation that should be used to reach this host.
remoteCharacterEncoding String The character encoding used to transcode files from one connection to the other
address String Address of the host
port Integer Port on which the Telnet or WinRM server runs
username String Username to connect with
password Password Password to use for authentication
winrmEnableHttps Boolean Enable SSL communication to the WinRM server
timeout String Timeout to use for WinRM messages in XML schema duration format
winrsAllowDelegate Boolean Specifies that the user’s credentials can be used to access a remote share, for example, found on a different machine than the target endpoint (WINRM_NATIVE only)
smbPort Integer Port on which the SMB2 server runs
pathShareMappings Map Mapping from Windows paths to Windows share names, e.g. C:\IBM\WebSphere -> WebSphereShare
os Enum Os
connectionType String Type of CIFS connection to create

customScriptTask

Custom Script Task

script

Shell script to execute on the remote host

scriptIgnoreVariableInterpolation

If disabled ‘${}’ placeholder will be replaced with variables defined in XLR. Variable interpolation is enabled by default.

remotePath

Path on the remote host where the script will be executed

output

Console output of the process

err

Error stream of the process

temporaryDirectoryPath

Directory in which temporary files are stored. This directory will be cleaned up when the connection is closed.

jumpstation

Jumpstation that should be used to reach this host.

remoteCharacterEncoding

The character encoding used to transcode files from one connection to the other

address

Address of the host

port

Port on which the Telnet or WinRM server runs

username

Username to connect with

password

Password to use for authentication

winrmEnableHttps

Enable SSL communication to the WinRM server

timeout

Timeout to use for WinRM messages in XML schema duration format

winrsAllowDelegate

Specifies that the user’s credentials can be used to access a remote share, for example, found on a different machine than the target endpoint (WINRM_NATIVE only)

smbPort

Port on which the SMB2 server runs

pathShareMappings

Mapping from Windows paths to Windows share names, e.g. C:\IBM\WebSphere -> WebSphereShare

os

Os

connectionType

Type of CIFS connection to create

Hidden properties

Property Kind Description
configurationUri String URI of the HTML file to render the task for custom script tasks
maxOutputPropertySize Integer Maximum size of output property values of type string. Default value is 32768
iconLocation String Icon Location
iconClass String Icon Class
outputVarHelpText String Output Var Help Text
taskColor String Task Color
preconditionEnabled Boolean Indicates whether preconditions should be enabled
failureHandlerEnabled Boolean Indicates whether failure handler should be enabled
scriptLocation String Script Location
tmpDeleteOnDisconnect Boolean If true, delete the temporary connection directory when the connection is closed
tmpFileCreationRetries Integer Number of times Overthere attempts to create a temporary file with a unique name
connectionTimeoutMillis Integer Number of milliseconds Overthere waits for a connection to a remote host to be established
winrmContext String Context used by the WinRM server (WINRM only)
winrmEnvelopSize Integer Envelop size for WinRM messages (WINRM only)
winrmLocale String Locale to use for WinRM messages (WINRM only)
winrmHttpsCertificateTrustStrategy Enum HTTPS certifiacte trust strategy for WinRM over HTTPS (WINRM_INTERNAL only)
winrmHttpsHostnameVerificationStrategy Enum HTTPS host name verification strategy for WinRM over HTTPS (WINRM_INTERNAL only)
winrmKerberosDebug Boolean Enable Kerberos debug messages (WINRM only)
winrmKerberosAddPortToSpn Boolean Add the port number (e.g. 5985) to the service principal name (SPN) for which a Kerberos ticket is requested (WINRM_INTERNAL only)
winrmKerberosUseHttpSpn Boolean Use the HTTP protocol in the service principal name (SPN) for which a Kerberos ticket is requested, instead of the default WSMAN protocol (WINRM_INTERNAL only)
winrsCompression Boolean Turn on compression. Older installations on remote machines may not support compression so it is off by default (WINRM_NATIVE only)
winrsNoecho Boolean Specifies that echo should be disabled. This may be necessary to ensure that user’s answers to remote prompts are not displayed locally (WINRM_NATIVE only)
winrsNoprofile Boolean Specifies that the user’s profile should not be loaded. By default the server will attempt to load the user profile. If the remote user is not a local administrator on the target system then this option will be required (the default willresult in error) (WINRM_NATIVE only)
winrsUnencrypted Boolean Disable encryption. Requires the remote host to have been configured to allow that (WINRM_NATIVE only)
protocol String Protocol

configurationUri

URI of the HTML file to render the task for custom script tasks

maxOutputPropertySize

Maximum size of output property values of type string. Default value is 32768

iconLocation

Icon Location

iconClass

Icon Class

outputVarHelpText

Output Var Help Text

taskColor

Task Color

preconditionEnabled

Indicates whether preconditions should be enabled

failureHandlerEnabled

Indicates whether failure handler should be enabled

scriptLocation

Script Location

tmpDeleteOnDisconnect

If true, delete the temporary connection directory when the connection is closed

tmpFileCreationRetries

Number of times Overthere attempts to create a temporary file with a unique name

connectionTimeoutMillis

Number of milliseconds Overthere waits for a connection to a remote host to be established

winrmContext

Context used by the WinRM server (WINRM only)

winrmEnvelopSize

Envelop size for WinRM messages (WINRM only)

winrmLocale

Locale to use for WinRM messages (WINRM only)

winrmHttpsCertificateTrustStrategy

HTTPS certifiacte trust strategy for WinRM over HTTPS (WINRM_INTERNAL only)

winrmHttpsHostnameVerificationStrategy

HTTPS host name verification strategy for WinRM over HTTPS (WINRM_INTERNAL only)

winrmKerberosDebug

Enable Kerberos debug messages (WINRM only)

winrmKerberosAddPortToSpn

Add the port number (e.g. 5985) to the service principal name (SPN) for which a Kerberos ticket is requested (WINRM_INTERNAL only)

winrmKerberosUseHttpSpn

Use the HTTP protocol in the service principal name (SPN) for which a Kerberos ticket is requested, instead of the default WSMAN protocol (WINRM_INTERNAL only)

winrsCompression

Turn on compression. Older installations on remote machines may not support compression so it is off by default (WINRM_NATIVE only)

winrsNoecho

Specifies that echo should be disabled. This may be necessary to ensure that user’s answers to remote prompts are not displayed locally (WINRM_NATIVE only)

winrsNoprofile

Specifies that the user’s profile should not be loaded. By default the server will attempt to load the user profile. If the remote user is not a local administrator on the target system then this option will be required (the default willresult in error) (WINRM_NATIVE only)

winrsUnencrypted

Disable encryption. Requires the remote host to have been configured to allow that (WINRM_NATIVE only)

protocol

Protocol