Class: Ansible::Ruby::Modules::Acme_certificate_revoke

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/crypto/acme/acme_certificate_revoke.rb

Overview

Allows to revoke certificates issued by a CA supporting the L(ACME protocol,tools.ietf.org/html/draft-ietf-acme-acme-14), such as L(Let’s Encrypt,letsencrypt.org/).

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

#account_key_content ⇒ Object?

Returns Content of the ACME account RSA or Elliptic Curve key.,Note that exactly one of C(account_key_src), C(account_key_content), C(private_key_src) or C(private_key_content) must be specified.,I(Warning): the content will be written into a temporary file, which will be deleted by Ansible when the module completes. Since this is an important private key — it can be used to change the account key, or to revoke your certificates without knowing their private keys —, this might not be acceptable.,In case C(cryptography) is used, the content is not written into a temporary file. It can still happen that it is written to disk by Ansible in the process of moving the module with its argument to the node where it is executed.

Returns:

  • (Object, nil) —

    Content of the ACME account RSA or Elliptic Curve key.,Note that exactly one of C(account_key_src), C(account_key_content), C(private_key_src) or C(private_key_content) must be specified.,I(Warning): the content will be written into a temporary file, which will be deleted by Ansible when the module completes. Since this is an important private key — it can be used to change the account key, or to revoke your certificates without knowing their private keys —, this might not be acceptable.,In case C(cryptography) is used, the content is not written into a temporary file. It can still happen that it is written to disk by Ansible in the process of moving the module with its argument to the node where it is executed.



20
 
# File 'lib/ansible/ruby/modules/generated/crypto/acme/acme_certificate_revoke.rb', line 20

attribute :account_key_content

#account_key_src ⇒ String?

Returns Path to a file containing the ACME account RSA or Elliptic Curve key.,RSA keys can be created with C(openssl rsa …). Elliptic curve keys can be created with C(openssl ecparam -genkey …). Any other tool creating private keys in PEM format can be used as well.,Mutually exclusive with C(account_key_content).,Required if C(account_key_content) is not used.

Returns:

  • (String, nil) —

    Path to a file containing the ACME account RSA or Elliptic Curve key.,RSA keys can be created with C(openssl rsa …). Elliptic curve keys can be created with C(openssl ecparam -genkey …). Any other tool creating private keys in PEM format can be used as well.,Mutually exclusive with C(account_key_content).,Required if C(account_key_content) is not used.



16
 
# File 'lib/ansible/ruby/modules/generated/crypto/acme/acme_certificate_revoke.rb', line 16

attribute :account_key_src

#certificate ⇒ String

Returns Path to the certificate to revoke.

Returns:

  • (String) —

    Path to the certificate to revoke.



12
 
# File 'lib/ansible/ruby/modules/generated/crypto/acme/acme_certificate_revoke.rb', line 12

attribute :certificate

#private_key_content ⇒ Object?

Returns Content of the certificate’s private key.,Note that exactly one of C(account_key_src), C(account_key_content), C(private_key_src) or C(private_key_content) must be specified.,I(Warning): the content will be written into a temporary file, which will be deleted by Ansible when the module completes. Since this is an important private key — it can be used to change the account key, or to revoke your certificates without knowing their private keys —, this might not be acceptable.,In case C(cryptography) is used, the content is not written into a temporary file. It can still happen that it is written to disk by Ansible in the process of moving the module with its argument to the node where it is executed.

Returns:

  • (Object, nil) —

    Content of the certificate’s private key.,Note that exactly one of C(account_key_src), C(account_key_content), C(private_key_src) or C(private_key_content) must be specified.,I(Warning): the content will be written into a temporary file, which will be deleted by Ansible when the module completes. Since this is an important private key — it can be used to change the account key, or to revoke your certificates without knowing their private keys —, this might not be acceptable.,In case C(cryptography) is used, the content is not written into a temporary file. It can still happen that it is written to disk by Ansible in the process of moving the module with its argument to the node where it is executed.



27
 
# File 'lib/ansible/ruby/modules/generated/crypto/acme/acme_certificate_revoke.rb', line 27

attribute :private_key_content

#private_key_src ⇒ String?

Returns Path to the certificate’s private key.,Note that exactly one of C(account_key_src), C(account_key_content), C(private_key_src) or C(private_key_content) must be specified.

Returns:

  • (String, nil) —

    Path to the certificate’s private key.,Note that exactly one of C(account_key_src), C(account_key_content), C(private_key_src) or C(private_key_content) must be specified.



23
 
# File 'lib/ansible/ruby/modules/generated/crypto/acme/acme_certificate_revoke.rb', line 23

attribute :private_key_src

#revoke_reason ⇒ Object?

Returns One of the revocation reasonCodes defined in L(tools.ietf.org/html/rfc5280#section-5.3.1, Section 5.3.1 of RFC5280).,Possible values are C(0) (unspecified), C(1) (keyCompromise), C(2) (cACompromise), C(3) (affiliationChanged), C(4) (superseded), C(5) (cessationOfOperation), C(6) (certificateHold), C(8) (removeFromCRL), C(9) (privilegeWithdrawn), C(10) (aACompromise).

Returns:

  • (Object, nil) —

    One of the revocation reasonCodes defined in L(tools.ietf.org/html/rfc5280#section-5.3.1, Section 5.3.1 of RFC5280).,Possible values are C(0) (unspecified), C(1) (keyCompromise), C(2) (cACompromise), C(3) (affiliationChanged), C(4) (superseded), C(5) (cessationOfOperation), C(6) (certificateHold), C(8) (removeFromCRL), C(9) (privilegeWithdrawn), C(10) (aACompromise)



30
 
# File 'lib/ansible/ruby/modules/generated/crypto/acme/acme_certificate_revoke.rb', line 30

attribute :revoke_reason