Class: Ansible::Ruby::Modules::Openssl_publickey

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

Overview

This module allows one to (re)generate OpenSSL public keys from their private keys. It uses the pyOpenSSL python library to interact with openssl. Keys are generated in PEM format. This module works only if the version of PyOpenSSL is recent enough (> 16.0.0).

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

#force ⇒ Symbol?

Returns Should the key be regenerated even it it already exists.

Returns:

  • (Symbol, nil) —

    Should the key be regenerated even it it already exists



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

attribute :force

#format ⇒ :PEM, ...

Returns The format of the public key.

Returns:

  • (:PEM, :OpenSSH, nil) —

    The format of the public key.



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

attribute :format

#path ⇒ String

Returns Name of the file in which the generated TLS/SSL public key will be written.

Returns:

  • (String) —

    Name of the file in which the generated TLS/SSL public key will be written.



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

attribute :path

#privatekey_passphrase ⇒ String?

Returns The passphrase for the privatekey.

Returns:

  • (String, nil) —

    The passphrase for the privatekey.



32
 
# File 'lib/ansible/ruby/modules/generated/crypto/openssl_publickey.rb', line 32

attribute :privatekey_passphrase

#privatekey_path ⇒ String

Returns Path to the TLS/SSL private key from which to generate the public key.

Returns:

  • (String) —

    Path to the TLS/SSL private key from which to generate the public key.



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

attribute :privatekey_path

#state ⇒ :present, ...

Returns Whether the public key should exist or not, taking action if the state is different from what is stated.

Returns:

  • (:present, :absent, nil) —

    Whether the public key should exist or not, taking action if the state is different from what is stated.



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

attribute :state