win_certificate_store – Manages the certificate store
win_certificate_store – Manages the certificate store
New in version 2.5.
Synopsis
- Used to import/export and remove certificates and keys from the local certificate store.
- This module is not used to create certificates and will only manage existing certs as a file or in the store.
- It can be used to import PEM, DER, P7B, PKCS12 (PFX) certificates and export PEM, DER and PKCS12 certificates.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
file_type - |
|
The file type to export the certificate as when
When |
key_exportable boolean |
|
Whether to allow the private key to be exported. If Used when |
key_storage - |
|
Specifies where Windows will store the private key when it is imported. When set to When set to When set to Used when |
password - |
The password of the pkcs12 certificate key. This is used when reading a pkcs12 certificate file or the password to set when If the pkcs12 file has no password set or no password should be set on the exported file, do not set this option. | |
path path |
The path to a certificate file. This is required when state is When state is | |
state - |
|
If If If When exporting a certificate, if path is a directory then the module will fail, otherwise the file will be replaced if needed. |
store_location - |
|
The store location to use when importing a certificate or searching for a certificate. |
store_name - |
|
The store name to use when importing a certificate or searching for a certificate.
|
thumbprint - |
The thumbprint as a hex string to either export or remove. See the examples for how to specify the thumbprint. |
Notes
Note
- Some actions on PKCS12 certificates and keys may fail with the error
the specified network password is not correct
, either use CredSSP or Kerberos with credential delegation, or usebecome
to bypass these restrictions. - The certificates must be located on the Windows host to be set with path.
- When importing a certificate for usage in IIS, it is generally required to use the
machine
key_storage option, as bothdefault
anduser
will make the private key unreadable to IIS APPPOOL identities and prevent binding the certificate to the https endpoint.
Examples
- name: import a certificate
win_certificate_store:
path: C:\Temp\cert.pem
state: present
- name: import pfx certificate that is password protected
win_certificate_store:
path: C:\Temp\cert.pfx
state: present
password: VeryStrongPasswordHere!
become: yes
become_method: runas
- name: import pfx certificate without password and set private key as un-exportable
win_certificate_store:
path: C:\Temp\cert.pfx
state: present
key_exportable: no
# usually you don't set this here but it is for illustrative purposes
vars:
ansible_winrm_transport: credssp
- name: remove a certificate based on file thumbprint
win_certificate_store:
path: C:\Temp\cert.pem
state: absent
- name: remove a certificate based on thumbprint
win_certificate_store:
thumbprint: BD7AF104CF1872BDB518D95C9534EA941665FD27
state: absent
- name: remove certificate based on thumbprint is CurrentUser/TrustedPublishers store
win_certificate_store:
thumbprint: BD7AF104CF1872BDB518D95C9534EA941665FD27
state: absent
store_location: CurrentUser
store_name: TrustedPublisher
- name: export certificate as der encoded file
win_certificate_store:
path: C:\Temp\cert.cer
state: exported
file_type: der
- name: export certificate and key as pfx encoded file
win_certificate_store:
path: C:\Temp\cert.pfx
state: exported
file_type: pkcs12
password: AnotherStrongPass!
become: yes
become_method: runas
become_user: SYSTEM
- name: import certificate be used by IIS
win_certificate_store:
path: C:\Temp\cert.pfx
file_type: pkcs12
password: StrongPassword!
store_location: LocalMachine
key_storage: machine
state: present
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
thumbprints list |
success |
A list of certificate thumbprints that were touched by the module.
Sample: ['BC05633694E675449136679A658281F17A191087'] |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Jordan Borean (@jborean93)
© 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/modules/win_certificate_store_module.html