psrp – Run tasks over Microsoft PowerShell Remoting Protocol
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 - |
|
var: ansible_psrp_auth |
The authentication protocol to use when authenticating the remote user. The default, |
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 | |
cert_validation - |
|
var: ansible_psrp_cert_validation |
Whether to validate the remote server's certificate or not. Set to 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 |
|
var: ansible_psrp_ignore_proxy |
Will disable any environment proxy settings and connect directly to the remote host. This option is ignored if |
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 |
message_encryption - |
|
var: ansible_psrp_message_encryption |
Controls the message encryption settings, this is different from TLS encryption when ansible_psrp_protocol is Only the auth protocols
|
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 |
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 | |
protocol - |
|
var: ansible_psrp_protocol |
Set the protocol to use for the connection. Default is |
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
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/plugins/connection/psrp.html