Class: Ansible::Ruby::Modules::Openssl_privatekey

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

Overview

This module allows one to (re)generate OpenSSL private keys. It uses the pyOpenSSL python library to interact with openssl. One can generate either RSA or DSA private keys. Keys are generated in PEM format.

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

#cipher ⇒ String?

Returns The cipher to encrypt the private key. (cipher can be found by running ‘openssl list-cipher-algorithms`).

Returns:

  • (String, nil) —

    The cipher to encrypt the private key. (cipher can be found by running ‘openssl list-cipher-algorithms`)



36
 
# File 'lib/ansible/ruby/modules/generated/crypto/openssl_privatekey.rb', line 36

attribute :cipher

#force ⇒ Symbol?

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

Returns:

  • (Symbol, nil) —

    Should the key be regenerated even if it already exists



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

attribute :force

#passphrase ⇒ String?

Returns The passphrase for the private key.

Returns:

  • (String, nil) —

    The passphrase for the private key.



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

attribute :passphrase

#path ⇒ String

Returns Name of the file in which the generated TLS/SSL private key will be written. It will have 0600 mode.

Returns:

  • (String) —

    Name of the file in which the generated TLS/SSL private key will be written. It will have 0600 mode.



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

attribute :path

#size ⇒ Integer?

Returns Size (in bits) of the TLS/SSL key to generate.

Returns:

  • (Integer, nil) —

    Size (in bits) of the TLS/SSL key to generate



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

attribute :size

#state ⇒ :present, ...

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

Returns:

  • (:present, :absent, nil) —

    Whether the private 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_privatekey.rb', line 12

attribute :state

#type ⇒ :RSA, ...

Returns The algorithm used to generate the TLS/SSL private key.

Returns:

  • (:RSA, :DSA, nil) —

    The algorithm used to generate the TLS/SSL private key



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

attribute :type