Documentation

psrp – Run tasks over Microsoft PowerShell Remoting Protocol

New in version 2.7.

Synopsis

  • Run commands or put/fetch on a target via PSRP (WinRM plugin)
  • This is similar to the winrm connection plugin which uses the same underlying transport but instead runs in a PowerShell interpreter.

Requirements

The below requirements are needed on the local master node that executes this connection.

  • pypsrp (Python library)

Parameters

Parameter Choices/Defaults Configuration Comments
auth
-
    Choices:
  • basic
  • certificate
  • negotiate ←
  • kerberos
  • ntlm
  • credssp
var: ansible_psrp_auth
The authentication protocol to use when authenticating the remote user.
The default, negotiate, will attempt to use Kerberos if it is available and fall back to NTLM if it isn't.
cert_trust_path
-
var: ansible_psrp_cert_trust_path
The path to a PEM certificate chain to use when validating the server's certificate.
This value is ignored if cert_validation is set to ignore.
cert_validation
-
    Choices:
  • validate ←
  • ignore
var: ansible_psrp_cert_validation
Whether to validate the remote server's certificate or not.
Set to ignore to not validate any certificates.
cert_trust_path can be set to the path of a PEM certificate chain to use in the validation.
configuration_name
-
Default:
Microsoft.PowerShell
var: ansible_psrp_configuration_name
The name of the PowerShell configuration endpoint to connect to.
connection_timeout
-
Default:
30
var: ansible_psrp_connection_timeout
The connection timeout for making the request to the remote host.
This is measured in seconds.
ignore_proxy
boolean
    Choices:
  • no ←
  • yes
var: ansible_psrp_ignore_proxy
Will disable any environment proxy settings and connect directly to the remote host.
This option is ignored if proxy is set.
max_envelope_size
-
Default:
153600
var: ansible_psrp_max_envelope_size
Sets the maximum size of each WSMan message sent to the remote host.
This is measured in bytes.
Defaults to 150KiB for compatibility with older hosts.
message_encryption
-
    Choices:
  • auto ←
  • always
  • never
var: ansible_psrp_message_encryption
Controls the message encryption settings, this is different from TLS encryption when ansible_psrp_protocol is https.
Only the auth protocols negotiate, kerberos, ntlm, and credssp can do message encryption. The other authentication protocols only support encryption when protocol is set to https.
auto means means message encryption is only used when not using TLS/HTTPS.
always is the same as auto but message encryption is always used even when running over TLS/HTTPS.
never disables any encryption checks that are in place when running over HTTP and disables any authentication encryption processes.
operation_timeout
-
Default:
20
var: ansible_psrp_operation_timeout
Sets the WSMan timeout for each operation.
This is measured in seconds.
This should not exceed the value for connection_timeout.
path
-
Default:
wsman
var: ansible_psrp_path
The URI path to connect to.
port
-
var: ansible_port
var: ansible_psrp_port
The port for PSRP to connect on the remote target.
Default is 5986 if protocol is not defined or is https, otherwise the port is 5985.
protocol
-
    Choices:
  • http
  • https
var: ansible_psrp_protocol
Set the protocol to use for the connection.
Default is https if port is not defined or port is not 5985.
proxy
-
var: ansible_psrp_proxy
Set the proxy URL to use when connecting to the remote host.
remote_addr
-
Default:
inventory_hostname
var: ansible_host
var: ansible_psrp_host
The hostname or IP address of the remote host.
remote_user
-
var: ansible_user
var: ansible_psrp_user
The user to log in as.

Status

Authors

  • Ansible Core Team

Hint

If you notice any issues in this documentation you can edit this document to improve it.