cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

get rid of Sphinx 2.1.2 errors (#59001)

Browse source
This commit is contained in:
Alicia Cozine 2019-07-12 15:19:08 -05:00 committed by Sandra McCann
parent 6645054329
commit 0dd3fb82eb
3 changed files with 14 additions and 55 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
docs/docsite/rst/user_guide/windows_dsc.rst
View file

@ -366,10 +366,7 @@ The first two methods above only work when the host has access to the internet.
When a host does not have internet access, the module must first be installed When a host does not have internet access, the module must first be installed
using the methods above on another host with internet access and then copied using the methods above on another host with internet access and then copied
across. To save a module to a local filepath, the following PowerShell cmdlet across. To save a module to a local filepath, the following PowerShell cmdlet
can be run: can be run::
.. comment: Pygments powershell lexer does not support colons (i.e. URLs)
.. code-block:: guess
Save-Module -Name xWebAdministration -Path C:\temp Save-Module -Name xWebAdministration -Path C:\temp

37
docs/docsite/rst/user_guide/windows_setup.rst
View file

@ -10,7 +10,7 @@ This document discusses the setup that is required before Ansible can communicat
Host Requirements Host Requirements
````````````````` `````````````````
For Ansible to communicate to a Windows host and use Windows modules, the For Ansible to communicate to a Windows host and use Windows modules, the
Windows host must meet the following requirements: Windows host must meet these requirements:
* Ansible's supported Windows versions generally match those under current * Ansible's supported Windows versions generally match those under current
and extended support from Microsoft. Supported desktop OSs include and extended support from Microsoft. Supported desktop OSs include
@ -148,9 +148,7 @@ following command:
winrm enumerate winrm/config/Listener winrm enumerate winrm/config/Listener
This will output something like the following: This will output something like::
.. code-block:: guess
Listener Listener
Address = * Address = *
@ -193,10 +191,7 @@ the key options that are useful to understand are:
* ``CertificateThumbprint``: If running over an HTTPS listener, this is the * ``CertificateThumbprint``: If running over an HTTPS listener, this is the
thumbprint of the certificate in the Windows Certificate Store that is used thumbprint of the certificate in the Windows Certificate Store that is used
in the connection. To get the details of the certificate itself, run this in the connection. To get the details of the certificate itself, run this
command with the relevant certificate thumbprint in PowerShell: command with the relevant certificate thumbprint in PowerShell::
.. comment: Pygments powershell lexer does not support colons (i.e. URLs)
.. code-block:: guess
$thumbprint = "E6CDAA82EEAF2ECE8546E05DB7F3E01AA47D76CE" $thumbprint = "E6CDAA82EEAF2ECE8546E05DB7F3E01AA47D76CE"
Get-ChildItem -Path cert:\LocalMachine\My -Recurse | Where-Object { $_.Thumbprint -eq $thumbprint } | Select-Object * Get-ChildItem -Path cert:\LocalMachine\My -Recurse | Where-Object { $_.Thumbprint -eq $thumbprint } | Select-Object *
@ -240,10 +235,7 @@ There are three ways to set up a WinRM listener:
Delete WinRM Listener Delete WinRM Listener
+++++++++++++++++++++ +++++++++++++++++++++
To remove a WinRM listener: To remove a WinRM listener::
.. comment: Pygments powershell lexer does not support colons (i.e. URLs)
.. code-block:: guess
# Remove all listeners # Remove all listeners
Remove-Item -Path WSMan:\localhost\Listener\* -Recurse -Force Remove-Item -Path WSMan:\localhost\Listener\* -Recurse -Force
@ -268,9 +260,7 @@ following command:
winrm get winrm/config/Service winrm get winrm/config/Service
winrm get winrm/config/Winrs winrm get winrm/config/Winrs
This will output something like the following: This will output something like::
.. code-block:: guess
Service Service
RootSDDL = O:NSG:BAD:P(A;;GA;;;BA)(A;;GR;;;IU)S:P(AU;FA;GA;;;WD)(AU;SA;GXGW;;;WD) RootSDDL = O:NSG:BAD:P(A;;GA;;;BA)(A;;GR;;;IU)S:P(AU;FA;GA;;;WD)(AU;SA;GXGW;;;WD)
@ -338,11 +328,7 @@ options are:
* ``Winrs\MaxMemoryPerShellMB``: This is the maximum amount of memory allocated * ``Winrs\MaxMemoryPerShellMB``: This is the maximum amount of memory allocated
per shell, including the shell's child processes. per shell, including the shell's child processes.
To modify a setting under the ``Service`` key in PowerShell, the following To modify a setting under the ``Service`` key in PowerShell::
command can be used:
.. comment: Pygments powershell lexer does not support colons (i.e. URLs)
.. code-block:: guess
# substitute {path} with the path to the option after winrm/config/Service # substitute {path} with the path to the option after winrm/config/Service
Set-Item -Path WSMan:\localhost\Service\{path} -Value "value here" Set-Item -Path WSMan:\localhost\Service\{path} -Value "value here"
@ -350,11 +336,7 @@ command can be used:
# for example, to change Service\Auth\CbtHardeningLevel run # for example, to change Service\Auth\CbtHardeningLevel run
Set-Item -Path WSMan:\localhost\Service\Auth\CbtHardeningLevel -Value Strict Set-Item -Path WSMan:\localhost\Service\Auth\CbtHardeningLevel -Value Strict
To modify a setting under the ``Winrs`` key in PowerShell, the following To modify a setting under the ``Winrs`` key in PowerShell::
command can be used:
.. comment: Pygments powershell lexer does not support colons (i.e. URLs)
.. code-block:: guess
# Substitute {path} with the path to the option after winrm/config/Winrs # Substitute {path} with the path to the option after winrm/config/Winrs
Set-Item -Path WSMan:\localhost\Shell\{path} -Value "value here" Set-Item -Path WSMan:\localhost\Shell\{path} -Value "value here"
@ -374,10 +356,7 @@ could in fact be issues with the host setup instead.
One easy way to determine whether a problem is a host issue is to One easy way to determine whether a problem is a host issue is to
run the following command from another Windows host to connect to the run the following command from another Windows host to connect to the
target Windows host: target Windows host::
.. comment: Pygments powershell lexer does not support -u:Username
.. code-block:: guess
# Test out HTTP # Test out HTTP
winrs -r:http://server:5985/wsman -u:Username -p:Password ipconfig winrs -r:http://server:5985/wsman -u:Username -p:Password ipconfig

27
docs/docsite/rst/user_guide/windows_winrm.rst
View file

@ -66,10 +66,7 @@ The following example shows host vars configured for basic authentication:
ansible_winrm_transport: basic ansible_winrm_transport: basic
Basic authentication is not enabled by default on a Windows host but can be Basic authentication is not enabled by default on a Windows host but can be
enabled by running the following in PowerShell: enabled by running the following in PowerShell::
.. comment: Pygments powershell lexer does not support colons (i.e. URLs)
.. code-block:: guess
Set-Item -Path WSMan:\localhost\Service\Auth\Basic -Value $true Set-Item -Path WSMan:\localhost\Service\Auth\Basic -Value $true
@ -88,10 +85,7 @@ The following example shows host vars configured for certificate authentication:
ansible_winrm_transport: certificate ansible_winrm_transport: certificate
Certificate authentication is not enabled by default on a Windows host but can Certificate authentication is not enabled by default on a Windows host but can
be enabled by running the following in PowerShell: be enabled by running the following in PowerShell::
.. comment: Pygments powershell lexer does not support colons (i.e. URLs)
.. code-block:: guess
Set-Item -Path WSMan:\localhost\Service\Auth\Certificate -Value $true Set-Item -Path WSMan:\localhost\Service\Auth\Certificate -Value $true
@ -212,12 +206,7 @@ The code to import the client certificate public key is:
Mapping a Certificate to an Account Mapping a Certificate to an Account
+++++++++++++++++++++++++++++++++++ +++++++++++++++++++++++++++++++++++
Once the certificate has been imported, it needs to be mapped to the local user account. Once the certificate has been imported, map it to the local user account::
This can be done with the following PowerShell command:
.. comment: Pygments powershell lexer does not support colons (i.e. URLs)
.. code-block:: guess
$username = "username" $username = "username"
$password = ConvertTo-SecureString -String "password" -AsPlainText -Force $password = ConvertTo-SecureString -String "password" -AsPlainText -Force
@ -514,10 +503,7 @@ another certificate.
certificate. With CredSSP, message transport still occurs over the WinRM listener, certificate. With CredSSP, message transport still occurs over the WinRM listener,
but the TLS-encrypted messages inside the channel use the service-level certificate. but the TLS-encrypted messages inside the channel use the service-level certificate.
To explicitly set the certificate to use for CredSSP: To explicitly set the certificate to use for CredSSP::
.. comment: Pygments powershell lexer does not support colons (i.e. URLs)
.. code-block:: guess
# Note the value $certificate_thumbprint will be different in each # Note the value $certificate_thumbprint will be different in each
# situation, this needs to be set based on the cert that is used. # situation, this needs to be set based on the cert that is used.
@ -566,10 +552,7 @@ A last resort is to disable the encryption requirement on the Windows host. This
should only be used for development and debugging purposes, as anything sent should only be used for development and debugging purposes, as anything sent
from Ansible can be viewed, manipulated and also the remote session can completely from Ansible can be viewed, manipulated and also the remote session can completely
be taken over by anyone on the same network. To disable the encryption be taken over by anyone on the same network. To disable the encryption
requirement, run the following from PowerShell on the target host: requirement::
.. comment: Pygments powershell lexer does not support colons (i.e. URLs)
.. code-block:: guess
Set-Item -Path WSMan:\localhost\Service\AllowUnencrypted -Value $true Set-Item -Path WSMan:\localhost\Service\AllowUnencrypted -Value $true