Class: Ansible::Ruby::Modules::Acme_account

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

Overview

Allows to create, modify or delete accounts with a CA supporting the L(ACME protocol,tools.ietf.org/html/draft-ietf-acme-acme-14), such as L(Let’s Encrypt,letsencrypt.org/). This module only works with the ACME v2 protocol.

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

#allow_creation ⇒ Boolean?

Returns Whether account creation is allowed (when state is C(present)).

Returns:

  • (Boolean, nil) —

    Whether account creation is allowed (when state is C(present)).



17
 
# File 'lib/ansible/ruby/modules/generated/crypto/acme/acme_account.rb', line 17

attribute :allow_creation

#contact ⇒ Object?

Returns A list of contact URLs.,Email addresses must be prefixed with C().,See tools.ietf.org/html/draft-ietf-acme-acme-14#section-7.1.2 for what is allowed.,Must be specified when state is C(present). Will be ignored if state is C(absent) or C(changed_key).

Returns:



21
 
# File 'lib/ansible/ruby/modules/generated/crypto/acme/acme_account.rb', line 21

attribute :contact

#new_account_key_content ⇒ String?

Returns Content of the ACME account RSA or Elliptic Curve key to change to.,Same restrictions apply as to C(account_key_content).,Mutually exclusive with C(new_account_key_src).,Required if C(new_account_key_src) is not used and state is C(changed_key).

Returns:

  • (String, nil) —

    Content of the ACME account RSA or Elliptic Curve key to change to.,Same restrictions apply as to C(account_key_content).,Mutually exclusive with C(new_account_key_src).,Required if C(new_account_key_src) is not used and state is C(changed_key).



31
 
# File 'lib/ansible/ruby/modules/generated/crypto/acme/acme_account.rb', line 31

attribute :new_account_key_content

#new_account_key_src ⇒ Object?

Returns Path to a file containing the ACME account RSA or Elliptic Curve key to change to.,Same restrictions apply as to C(account_key_src).,Mutually exclusive with C(new_account_key_content).,Required if C(new_account_key_content) is not used and state is C(changed_key).

Returns:

  • (Object, nil) —

    Path to a file containing the ACME account RSA or Elliptic Curve key to change to.,Same restrictions apply as to C(account_key_src).,Mutually exclusive with C(new_account_key_content).,Required if C(new_account_key_content) is not used and state is C(changed_key).



28
 
# File 'lib/ansible/ruby/modules/generated/crypto/acme/acme_account.rb', line 28

attribute :new_account_key_src

#state ⇒ :present, ...

Returns The state of the account, to be identified by its account key.,If the state is C(absent), the account will either not exist or be deactivated.,If the state is C(changed_key), the account must exist. The account key will be changed; no other information will be touched.

Returns:

  • (:present, :absent, :changed_key) —

    The state of the account, to be identified by its account key.,If the state is C(absent), the account will either not exist or be deactivated.,If the state is C(changed_key), the account must exist. The account key will be changed; no other information will be touched.



13
 
# File 'lib/ansible/ruby/modules/generated/crypto/acme/acme_account.rb', line 13

attribute :state

#terms_agreed ⇒ Symbol?

Returns Boolean indicating whether you agree to the terms of service document.,ACME servers can require this to be true.

Returns:

  • (Symbol, nil) —

    Boolean indicating whether you agree to the terms of service document.,ACME servers can require this to be true.



24
 
# File 'lib/ansible/ruby/modules/generated/crypto/acme/acme_account.rb', line 24

attribute :terms_agreed