Class: Ansible::Ruby::Modules::One_image_facts

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

Overview

Gather facts about OpenNebula images

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

#api_password ⇒ Object?

Returns Password of the user to login into OpenNebula RPC server. If not set,then the value of the C(ONE_PASSWORD) environment variable is used.

Returns:

  • (Object, nil) —

    Password of the user to login into OpenNebula RPC server. If not set,then the value of the C(ONE_PASSWORD) environment variable is used.



18
 
# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_image_facts.rb', line 18

attribute :api_password

#api_url ⇒ Object?

Returns URL of the OpenNebula RPC server.,It is recommended to use HTTPS so that the username/password are not,transferred over the network unencrypted.,If not set then the value of the C(ONE_URL) environment variable is used.

Returns:

  • (Object, nil) —

    URL of the OpenNebula RPC server.,It is recommended to use HTTPS so that the username/password are not,transferred over the network unencrypted.,If not set then the value of the C(ONE_URL) environment variable is used.



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_image_facts.rb', line 12

attribute :api_url

#api_username ⇒ Object?

Returns Name of the user to login into the OpenNebula RPC server. If not set,then the value of the C(ONE_USERNAME) environment variable is used.

Returns:

  • (Object, nil) —

    Name of the user to login into the OpenNebula RPC server. If not set,then the value of the C(ONE_USERNAME) environment variable is used.



15
 
# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_image_facts.rb', line 15

attribute :api_username

#ids ⇒ Array<Integer>, ...

Returns A list of images ids whose facts you want to gather.

Returns:

  • (Array<Integer>, Integer, nil) —

    A list of images ids whose facts you want to gather.



21
 
# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_image_facts.rb', line 21

attribute :ids

#name ⇒ String?

Returns A C(name) of the image whose facts will be gathered.,If the C(name) begins with ‘~’ the C(name) will be used as regex pattern,which restricts the list of images (whose facts will be returned) whose names match specified regex.,Also, if the C(name) begins with ‘~*’ case-insensitive matching will be performed.,See examples for more details.

Returns:

  • (String, nil) —

    A C(name) of the image whose facts will be gathered.,If the C(name) begins with ‘~’ the C(name) will be used as regex pattern,which restricts the list of images (whose facts will be returned) whose names match specified regex.,Also, if the C(name) begins with ‘~*’ case-insensitive matching will be performed.,See examples for more details.



25
 
# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_image_facts.rb', line 25

attribute :name