Class: Ansible::Ruby::Modules::Win_certificate_store

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/windows/win_certificate_store.rb

Overview

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.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#file_type ⇒ :der, ...

Returns The file type to export the certificate as when C(state=exported).,C(der) is a binary ASN.1 encoded file.,C(pem) is a base64 encoded file of a der file in the OpenSSL form.,C(pkcs12) (also known as pfx) is a binary container that contains both the certificate and private key unlike the other options.,When C(pkcs12) is set and the private key is not exportable or accessible by the current user, it will throw an exception.

Returns:

  • (:der, :pem, :pkcs12, nil) —

    The file type to export the certificate as when C(state=exported).,C(der) is a binary ASN.1 encoded file.,C(pem) is a base64 encoded file of a der file in the OpenSSL form.,C(pkcs12) (also known as pfx) is a binary container that contains both the certificate and private key unlike the other options.,When C(pkcs12) is set and the private key is not exportable or accessible by the current user, it will throw an exception.



46
 
# File 'lib/ansible/ruby/modules/generated/windows/win_certificate_store.rb', line 46

attribute :file_type

#key_exportable ⇒ :yes, ...

Returns Whether to allow the private key to be exported.,If C(no), then this module and other process will only be able to export the certificate and the private key cannot be exported.,Used when C(state=present) only.

Returns:

  • (:yes, :no, nil) —

    Whether to allow the private key to be exported.,If C(no), then this module and other process will only be able to export the certificate and the private key cannot be exported.,Used when C(state=present) only.



38
 
# File 'lib/ansible/ruby/modules/generated/windows/win_certificate_store.rb', line 38

attribute :key_exportable

#key_storage ⇒ :default, ...

Returns Specifies where Windows will store the private key when it is imported.,When set to C(default), the default option as set by Windows is used.,When set to C(machine), the key is stored in a path accessible by various users.,When set to C(user), the key is stored in a path only accessible by the current user.,Used when C(state=present) only and cannot be changed once imported.,See U(msdn.microsoft.com/en-us/library/system.security.cryptography.x509certificates.x509keystorageflags.aspx) for more details.

Returns:

  • (:default, :machine, :user, nil) —

    Specifies where Windows will store the private key when it is imported.,When set to C(default), the default option as set by Windows is used.,When set to C(machine), the key is stored in a path accessible by various users.,When set to C(user), the key is stored in a path only accessible by the current user.,Used when C(state=present) only and cannot be changed once imported.,See U(msdn.microsoft.com/en-us/library/system.security.cryptography.x509certificates.x509keystorageflags.aspx) for more details.



42
 
# File 'lib/ansible/ruby/modules/generated/windows/win_certificate_store.rb', line 42

attribute :key_storage

#password ⇒ String?

Returns The password of the pkcs12 certificate key.,This is used when reading a pkcs12 certificate file or the password to set when C(state=exported) and C(file_type=pkcs12).,If the pkcs12 file has no password set or no password should be set on the exported file, do not set this option.

Returns:

  • (String, nil) —

    The password of the pkcs12 certificate key.,This is used when reading a pkcs12 certificate file or the password to set when C(state=exported) and C(file_type=pkcs12).,If the pkcs12 file has no password set or no password should be set on the exported file, do not set this option.



34
 
# File 'lib/ansible/ruby/modules/generated/windows/win_certificate_store.rb', line 34

attribute :password

#path ⇒ String?

Returns The path to a certificate file.,This is required when I(state) is C(present) or C(exported).,When I(state) is C(absent) and I(thumbprint) is not specified, the thumbprint is derived from the certificate at this path.

Returns:

  • (String, nil) —

    The path to a certificate file.,This is required when I(state) is C(present) or C(exported).,When I(state) is C(absent) and I(thumbprint) is not specified, the thumbprint is derived from the certificate at this path.



18
 
# File 'lib/ansible/ruby/modules/generated/windows/win_certificate_store.rb', line 18

attribute :path

#state ⇒ :absent, ...

Returns If C(present), will ensure that the certificate at I(path) is imported into the certificate store specified.,If C(absent), will ensure that the certificate specified by I(thumbprint) or the thumbprint of the cert at I(path) is removed from the store specified.,If C(exported), will ensure the file at I(path) is a certificate specified by I(thumbprint).,When exporting a certificate, if I(path) is a directory then the module will fail, otherwise the file will be replaced if needed.

Returns:

  • (:absent, :exported, :present, nil) —

    If C(present), will ensure that the certificate at I(path) is imported into the certificate store specified.,If C(absent), will ensure that the certificate specified by I(thumbprint) or the thumbprint of the cert at I(path) is removed from the store specified.,If C(exported), will ensure the file at I(path) is a certificate specified by I(thumbprint).,When exporting a certificate, if I(path) is a directory then the module will fail, otherwise the file will be replaced if needed.



14
 
# File 'lib/ansible/ruby/modules/generated/windows/win_certificate_store.rb', line 14

attribute :state

#store_location ⇒ :CurrentUser, ...

Returns The store location to use when importing a certificate or searching for a certificate.

Returns:

  • (:CurrentUser, :LocalMachine, nil) —

    The store location to use when importing a certificate or searching for a certificate.



30
 
# File 'lib/ansible/ruby/modules/generated/windows/win_certificate_store.rb', line 30

attribute :store_location

#store_name ⇒ :AddressBook, ...

Returns The store name to use when importing a certificate or searching for a certificate.,C(AddressBook): The X.509 certificate store for other users,C(AuthRoot): The X.509 certificate store for third-party certificate authorities (CAs),C(CertificateAuthority): The X.509 certificate store for intermediate certificate authorities (CAs),C(Disallowed): The X.509 certificate store for revoked certificates,C(My): The X.509 certificate store for personal certificates,C(Root): The X.509 certificate store for trusted root certificate authorities (CAs),C(TrustedPeople): The X.509 certificate store for directly trusted people and resources,C(TrustedPublisher): The X.509 certificate store for directly trusted publishers.

Returns:

  • (:AddressBook, :AuthRoot, :CertificateAuthority, :Disallowed, :My, :Root, :TrustedPeople, :TrustedPublisher, nil) —

    The store name to use when importing a certificate or searching for a certificate.,C(AddressBook): The X.509 certificate store for other users,C(AuthRoot): The X.509 certificate store for third-party certificate authorities (CAs),C(CertificateAuthority): The X.509 certificate store for intermediate certificate authorities (CAs),C(Disallowed): The X.509 certificate store for revoked certificates,C(My): The X.509 certificate store for personal certificates,C(Root): The X.509 certificate store for trusted root certificate authorities (CAs),C(TrustedPeople): The X.509 certificate store for directly trusted people and resources,C(TrustedPublisher): The X.509 certificate store for directly trusted publishers



26
 
# File 'lib/ansible/ruby/modules/generated/windows/win_certificate_store.rb', line 26

attribute :store_name

#thumbprint ⇒ String?

Returns The thumbprint as a hex string to either export or remove.,See the examples for how to specify the thumbprint.

Returns:

  • (String, nil) —

    The thumbprint as a hex string to either export or remove.,See the examples for how to specify the thumbprint.



22
 
# File 'lib/ansible/ruby/modules/generated/windows/win_certificate_store.rb', line 22

attribute :thumbprint