diff options
| author | Dag Wieers <dag@wieers.com> | 2017-02-04 08:52:01 +0100 |
|---|---|---|
| committer | John R Barker <john@johnrbarker.com> | 2017-02-04 08:52:01 +0100 |
| commit | 28060a4c47d3f86ccc595537deb91c88ff602eee (patch) | |
| tree | 95605ac250d660691963d806df038710779ae878 /examples/scripts | |
| parent | f75ffe46db3c6731d5f4ecf2ad789dc7c3c332cb (diff) | |
| download | ansible-28060a4c47d3f86ccc595537deb91c88ff602eee.tar.gz | |
Improve inline docs (#21029)
Diffstat (limited to 'examples/scripts')
| -rw-r--r-- | examples/scripts/ConfigureRemotingForAnsible.ps1 | 21 |
1 files changed, 14 insertions, 7 deletions
diff --git a/examples/scripts/ConfigureRemotingForAnsible.ps1 b/examples/scripts/ConfigureRemotingForAnsible.ps1 index e9e15bbfe6..e8998d1d2e 100644 --- a/examples/scripts/ConfigureRemotingForAnsible.ps1 +++ b/examples/scripts/ConfigureRemotingForAnsible.ps1 @@ -3,23 +3,30 @@ # Configure a Windows host for remote management with Ansible # ----------------------------------------------------------- # -# This script checks the current WinRM/PSRemoting configuration and makes the -# necessary changes to allow Ansible to connect, authenticate and execute -# PowerShell commands. +# This script checks the current WinRM (PS Remoting) configuration and makes +# the # necessary changes to allow Ansible to connect, authenticate and +# execute PowerShell commands. # # All events are logged to the Windows EventLog, useful for unattended runs. # # Use option -Verbose in order to see the verbose output messages. # -# Use option -SkipNetworkProfileCheck to skip the network profile check. -# Without specifying this the script will only run if the device's interfaces -# are in DOMAIN or PRIVATE zones. Provide this switch if you want to enable -# WinRM on a device with an interface in PUBLIC zone. +# Use option -CertValidityDays to specify how long this certificate is valid +# starting from today. So you would specify -CertValidityDays 3650 to get +# a 10-year valid certificate. # # Use option -ForceNewSSLCert if the system has been SysPreped and a new # SSL Certifcate must be forced on the WinRM Listener when re-running this # script. This is necessary when a new SID and CN name is created. # +# Use option -SkipNetworkProfileCheck to skip the network profile check. +# Without specifying this the script will only run if the device's interfaces +# are in DOMAIN or PRIVATE zones. Provide this switch if you want to enable +# WinRM on a device with an interface in PUBLIC zone. +# +# Use option -SubjectName to specify the CN name of the certificate. This +# defaults to the system's hostname and generally should not be specified. + # Written by Trond Hindenes <trond@hindenes.com> # Updated by Chris Church <cchurch@ansible.com> # Updated by Michael Crilly <mike@autologic.cm> |