ConnectorTypePS

class connector_types.connector_type_ps.ConnectorTypePS

Access a Windows Remote Management (WinRM) service.

This connector type enables you to interact with a Windows Remote Management (WinRM) service. See Windows Remote Management for information about WinRM.

Inputs

Name	Type	Default	Description
cert_key_pem	str	None	Provide a certificate key in PEM format when using SSL transport, otherwise transport is reverted to basic auth over HTTPS.
cert_pem	str	None	Provide a certificate in PEM format when using SSL transport, otherwise transport is reverted to basic auth over HTTPS.
encoding	str	utf-8	The character encoding used on the remote host.
host	str		The hostname or IP of the remote windows host.
message_encryption	str	auto	If to use message encryption. See Encryption.
password	str		The password to use for authentication.
run_bat	str	None	A batch script to execute on the remote windows host. One of run_cmd, run_ps, or run_bat is required.
run_cmd	str	None	A command to execute on the remote windows host. One of run_cmd, run_ps, or run_bat is required.
run_cmd_args	list	None	Arguments for the command executed by run_cmd.
run_ps	str	None	A powershell script to execute on the remote windows host. One of run_cmd, run_ps, or run_bat is required.
transport	str	ssl	Which transport to use. See Valid transport options.
username	str		The username to use for authentication.

Outputs

Name	Type	Default	Description
execution_id	int		The ID of the connection execution
message	str		The ended message for the connection. If the connection ended with an error, the message will contain information about what went wrong
status	str		The ended status for the connection. Either "success" or "error".
status_code	int		The status code of the executed command.
std_err	str		The standard error of the executed command.
std_out	str		The standard output of the executed command.

Constants

input_list = ['cert_key_pem', 'cert_pem', 'encoding', 'host', 'message_encryption', 'password', 'run_bat', 'run_cmd', 'run_cmd_args', 'run_ps', 'transport', 'username'] output_list = ['status_code', 'std_err', 'std_out'] ssl_context_inputs = ['check_hostname', 'client_cert', 'client_key', 'server_ca'] version = 1

Methods

execute ()

log (message)

one_of_inputs (options)

run ()

Example

import flow_api

def handler(system: flow_api.System, this: flow_api.Execution):
    this.connect(
        connector_type='PS',
        host='my-windows-host',
        username='kevin',
        password='secret',
        run_cmd='ipconfig',
    )
    this.connect(
        connector_type='PS',
        host='my-windows-host',
        username='kevin',
        password='secret',
        run_ps='Write-Host "Hello World!"',
    )
    return this.success('all done')