Close
    logoCloudomation Docs

    TaskPS

    class tasks.task_ps.TaskPS

    Access a Windows Remote Management (WinRM) service.

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

    Inputs

    NameTypeDefaultDescription
    hoststrThe hostname or IP of the remote windows host
    message_encryptionstrautoIf to use message encryption. See Encryption
    passwordstrThe password to use for authentication
    run_cmdstrNoneThe command to execute on the remote windows host
    run_cmd_argslistNoneArguments for the command executed by run_cmd
    run_psstrNoneThe powershell script to execute on the remote windows host
    transportstrntlmWhich transport to use. See Valid transport options
    usernamestrThe username to use for authentication

    Outputs

    NameTypeDefaultDescription
    status_codeintThe status code of the executed command
    std_errstrThe standard error of the executed command
    std_outstrThe standard output of the executed command
    execution_idintThe ID of the task execution
    messagestrThe ended message for the task. If the task ended with an error, the message will contain information about what went wrong
    statusstrThe ended status for the task. Either "success" or "error".

    Constants

    input_list = ['host', 'message_encryption', 'password', 'run_cmd', 'run_cmd_args', 'run_ps', 'transport', 'username']output_list = ['status_code', 'std_err', 'std_out']version = 1

    Methods

    log (message)
    run ()

    Example

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