Class: Ansible::Ruby::Modules::One_service

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

Overview

Manage OpenNebula services

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 OneFlow API server. If not set then the value of the C(ONEFLOW_PASSWORD) environment variable is used.

Returns:

  • (Object, nil) —

    Password of the user to login into OpenNebula OneFlow API server. If not set then the value of the C(ONEFLOW_PASSWORD) environment variable is used.



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

attribute :api_password

#api_url ⇒ Object?

Returns URL of the OpenNebula OneFlow API 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 ONEFLOW_URL environment variable is used.

Returns:

  • (Object, nil) —

    URL of the OpenNebula OneFlow API 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 ONEFLOW_URL environment variable is used.



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

attribute :api_url

#api_username ⇒ Object?

Returns Name of the user to login into the OpenNebula OneFlow API server. If not set then the value of the C(ONEFLOW_USERNAME) environment variable is used.

Returns:

  • (Object, nil) —

    Name of the user to login into the OpenNebula OneFlow API server. If not set then the value of the C(ONEFLOW_USERNAME) environment variable is used.



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

attribute :api_username

#cardinality ⇒ Integer?

Returns Number of VMs for the specified role.

Returns:

  • (Integer, nil) —

    Number of VMs for the specified role



72
 
# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_service.rb', line 72

attribute :cardinality

#custom_attrs ⇒ Object?

Returns Dictionary of key/value custom attributes which will be used when instantiating a new service.

Returns:

  • (Object, nil) —

    Dictionary of key/value custom attributes which will be used when instantiating a new service.



65
 
# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_service.rb', line 65

attribute :custom_attrs

#force ⇒ Symbol?

Returns Force the new cardinality even if it is outside the limits.

Returns:

  • (Symbol, nil) —

    Force the new cardinality even if it is outside the limits



76
 
# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_service.rb', line 76

attribute :force

#group_id ⇒ Integer?

Returns ID of the group which will be set as the group of the service.

Returns:

  • (Integer, nil) —

    ID of the group which will be set as the group of the service



53
 
# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_service.rb', line 53

attribute :group_id

#mode ⇒ String?

Returns Set permission mode of a service instance in octet format, e.g. C(600) to give owner C(use) and C(manage) and nothing to group and others.

Returns:

  • (String, nil) —

    Set permission mode of a service instance in octet format, e.g. C(600) to give owner C(use) and C(manage) and nothing to group and others.



45
 
# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_service.rb', line 45

attribute :mode

#owner_id ⇒ Integer?

Returns ID of the user which will be set as the owner of the service.

Returns:

  • (Integer, nil) —

    ID of the user which will be set as the owner of the service



49
 
# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_service.rb', line 49

attribute :owner_id

#role ⇒ String?

Returns Name of the role whose cardinality should be changed.

Returns:

  • (String, nil) —

    Name of the role whose cardinality should be changed



68
 
# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_service.rb', line 68

attribute :role

#service_id ⇒ Integer?

Returns ID of a service instance that you would like to manage.

Returns:

  • (Integer, nil) —

    ID of a service instance that you would like to manage



29
 
# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_service.rb', line 29

attribute :service_id

#service_name ⇒ String?

Returns Name of a service instance that you would like to manage.

Returns:

  • (String, nil) —

    Name of a service instance that you would like to manage



33
 
# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_service.rb', line 33

attribute :service_name

#state ⇒ :present, ...

Returns C(present) - instantiate a service from a template specified with C(template_id)/C(template_name).,C(absent) - terminate an instance of a service specified with C(service_id)/C(service_name).

Returns:

  • (:present, :absent, nil) —

    C(present) - instantiate a service from a template specified with C(template_id)/C(template_name).,C(absent) - terminate an instance of a service specified with C(service_id)/C(service_name).



41
 
# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_service.rb', line 41

attribute :state

#template_id ⇒ Integer?

Returns ID of a service template to use to create a new instance of a service.

Returns:

  • (Integer, nil) —

    ID of a service template to use to create a new instance of a service



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

attribute :template_id

#template_name ⇒ String?

Returns Name of service template to use to create a new instace of a service.

Returns:

  • (String, nil) —

    Name of service template to use to create a new instace of a service



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

attribute :template_name

#unique ⇒ Symbol?

Returns Setting C(unique=yes) will make sure that there is only one service instance running with a name set with C(service_name) when,instantiating a service from a template specified with C(template_id)/C(template_name). Check examples below.

Returns:

  • (Symbol, nil) —

    Setting C(unique=yes) will make sure that there is only one service instance running with a name set with C(service_name) when,instantiating a service from a template specified with C(template_id)/C(template_name). Check examples below.



37
 
# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_service.rb', line 37

attribute :unique

#wait ⇒ Symbol?

Returns Wait for the instance to reach RUNNING state after DEPLOYING or COOLDOWN state after SCALING.

Returns:

  • (Symbol, nil) —

    Wait for the instance to reach RUNNING state after DEPLOYING or COOLDOWN state after SCALING



57
 
# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_service.rb', line 57

attribute :wait

#wait_timeout ⇒ Integer?

Returns How long before wait gives up, in seconds.

Returns:

  • (Integer, nil) —

    How long before wait gives up, in seconds



61
 
# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_service.rb', line 61

attribute :wait_timeout