Class: Ansible::Ruby::Modules::Digital_ocean_snapshot_facts

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

Overview

This module can be used to gather facts about snapshot facts based upon provided values such as droplet, volume and snapshot id.

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

#snapshot_id ⇒ Integer, ...

Returns To retrieve information about a snapshot, please specify this as a snapshot id.,If set to actual snapshot id, then facts are gathered related to that particular snapshot only.,This is required parameter, if C(snapshot_type) is set to C(by_id).

Returns:

  • (Integer, String, nil) —

    To retrieve information about a snapshot, please specify this as a snapshot id.,If set to actual snapshot id, then facts are gathered related to that particular snapshot only.,This is required parameter, if C(snapshot_type) is set to C(by_id).



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/digital_ocean/digital_ocean_snapshot_facts.rb', line 16

attribute :snapshot_id

#snapshot_type ⇒ :all, ...

Returns Specifies the type of snapshot facts to be retrived.,If set to C(droplet), then facts are gathered related to snapshots based on Droplets only.,If set to C(volume), then facts are gathered related to snapshots based on volumes only.,If set to C(by_id), then facts are gathered related to snapshots based on snapshot id only.,If not set to any of the above, then facts are gathered related to all snapshots.

Returns:

  • (:all, :droplet, :volume, :by_id, nil) —

    Specifies the type of snapshot facts to be retrived.,If set to C(droplet), then facts are gathered related to snapshots based on Droplets only.,If set to C(volume), then facts are gathered related to snapshots based on volumes only.,If set to C(by_id), then facts are gathered related to snapshots based on snapshot id only.,If not set to any of the above, then facts are gathered related to all snapshots.



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/digital_ocean/digital_ocean_snapshot_facts.rb', line 12

attribute :snapshot_type