Class: Ansible::Ruby::Modules::Packet_sshkey

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/packet/packet_sshkey.rb

Overview

Create/delete an SSH key in Packet host. API is documented at U(www.packet.net/help/api/#page:ssh-keys,header:ssh-keys-ssh-keys-post).

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

#auth_token ⇒ Object?

Returns Packet api token. You can also supply it in env var C(PACKET_API_TOKEN).

Returns:

  • (Object, nil) —

    Packet api token. You can also supply it in env var C(PACKET_API_TOKEN).



17
 
# File 'lib/ansible/ruby/modules/generated/cloud/packet/packet_sshkey.rb', line 17

attribute :auth_token

#fingerprint ⇒ Object?

Returns Fingerprint of the key which you want to remove.

Returns:

  • (Object, nil) —

    Fingerprint of the key which you want to remove.



26
 
# File 'lib/ansible/ruby/modules/generated/cloud/packet/packet_sshkey.rb', line 26

attribute :fingerprint

#id ⇒ Object?

Returns UUID of the key which you want to remove.

Returns:

  • (Object, nil) —

    UUID of the key which you want to remove.



23
 
# File 'lib/ansible/ruby/modules/generated/cloud/packet/packet_sshkey.rb', line 23

attribute :id

#key ⇒ Object?

Returns Public Key string (type encoded key description).

Returns:

  • (Object, nil) —

    Public Key string (type encoded key description).



29
 
# File 'lib/ansible/ruby/modules/generated/cloud/packet/packet_sshkey.rb', line 29

attribute :key

#key_file ⇒ Object?

Returns File with the public key.

Returns:

  • (Object, nil) —

    File with the public key.



32
 
# File 'lib/ansible/ruby/modules/generated/cloud/packet/packet_sshkey.rb', line 32

attribute :key_file

#label ⇒ Object?

Returns Label for the key. If you keep it empty, it will be read from key string.

Returns:

  • (Object, nil) —

    Label for the key. If you keep it empty, it will be read from key string.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/packet/packet_sshkey.rb', line 20

attribute :label

#state ⇒ :present, ...

Returns Indicate desired state of the target.

Returns:

  • (:present, :absent, nil) —

    Indicate desired state of the target.



13
 
# File 'lib/ansible/ruby/modules/generated/cloud/packet/packet_sshkey.rb', line 13

attribute :state