Class: Ansible::Ruby::Modules::Vultr_server

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/vultr/vr_server.rb,
lib/ansible/ruby/modules/generated/cloud/vultr/vultr_server.rb

Overview

Deploy, start, stop, update, restart, reinstall servers.

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

#auto_backup_enabled ⇒ Symbol?

Returns Whether to enable automatic backups or not.

Returns:

  • (Symbol, nil) —

    Whether to enable automatic backups or not.



42
 
# File 'lib/ansible/ruby/modules/generated/cloud/vultr/vr_server.rb', line 42

attribute :auto_backup_enabled

#firewall_group ⇒ Object?

Returns The firewall group to assign this server to.

Returns:

  • (Object, nil) —

    The firewall group to assign this server to.



23
 
# File 'lib/ansible/ruby/modules/generated/cloud/vultr/vr_server.rb', line 23

attribute :firewall_group

#force ⇒ Symbol?

Returns Force stop/start the server if required to apply changes,Otherwise a running server will not be changed.

Returns:

  • (Symbol, nil) —

    Force stop/start the server if required to apply changes,Otherwise a running server will not be changed.



30
 
# File 'lib/ansible/ruby/modules/generated/cloud/vultr/vr_server.rb', line 30

attribute :force

#hostname ⇒ Object?

Returns Hostname to assign to this server.

Returns:

  • (Object, nil) —

    Hostname to assign to this server.



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/vultr/vr_server.rb', line 16

attribute :hostname

#ipv6_enabled ⇒ Symbol?

Returns Whether to enable IPv6 or not.

Returns:

  • (Symbol, nil) —

    Whether to enable IPv6 or not.



46
 
# File 'lib/ansible/ruby/modules/generated/cloud/vultr/vr_server.rb', line 46

attribute :ipv6_enabled

#name ⇒ String

Returns Name of the server.

Returns:

  • (String) —

    Name of the server.



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/vultr/vr_server.rb', line 12

attribute :name

#notify_activate ⇒ Symbol?

Returns Whether to send an activation email when the server is ready or not.,Only considered on creation.

Returns:

  • (Symbol, nil) —

    Whether to send an activation email when the server is ready or not.,Only considered on creation.



34
 
# File 'lib/ansible/ruby/modules/generated/cloud/vultr/vr_server.rb', line 34

attribute :notify_activate

#os ⇒ String?

Returns The operating system.,Required if the server does not yet exist.

Returns:

  • (String, nil) —

    The operating system.,Required if the server does not yet exist.



19
 
# File 'lib/ansible/ruby/modules/generated/cloud/vultr/vr_server.rb', line 19

attribute :os

#plan ⇒ Array<String>, ...

Returns Plan to use for the server.,Required if the server does not yet exist.

Returns:

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

    Plan to use for the server.,Required if the server does not yet exist.



26
 
# File 'lib/ansible/ruby/modules/generated/cloud/vultr/vr_server.rb', line 26

attribute :plan

#private_network_enabled ⇒ Symbol?

Returns Whether to enable private networking or not.

Returns:

  • (Symbol, nil) —

    Whether to enable private networking or not.



38
 
# File 'lib/ansible/ruby/modules/generated/cloud/vultr/vr_server.rb', line 38

attribute :private_network_enabled

#region ⇒ String?

Returns Region the server is deployed into.,Required if the server does not yet exist.

Returns:

  • (String, nil) —

    Region the server is deployed into.,Required if the server does not yet exist.



65
 
# File 'lib/ansible/ruby/modules/generated/cloud/vultr/vr_server.rb', line 65

attribute :region

#reserved_ip_v4 ⇒ Object?

Returns IP address of the floating IP to use as the main IP of this server.,Only considered on creation.

Returns:

  • (Object, nil) —

    IP address of the floating IP to use as the main IP of this server.,Only considered on creation.



62
 
# File 'lib/ansible/ruby/modules/generated/cloud/vultr/vr_server.rb', line 62

attribute :reserved_ip_v4

#ssh_keys ⇒ Object?

Returns List of SSH keys passed to the server on creation.

Returns:

  • (Object, nil) —

    List of SSH keys passed to the server on creation.



59
 
# File 'lib/ansible/ruby/modules/generated/cloud/vultr/vr_server.rb', line 59

attribute :ssh_keys

#startup_script ⇒ Object?

Returns Name of the startup script to execute on boot.,Only considered while creating the server.

Returns:

  • (Object, nil) —

    Name of the startup script to execute on boot.,Only considered while creating the server.



56
 
# File 'lib/ansible/ruby/modules/generated/cloud/vultr/vr_server.rb', line 56

attribute :startup_script

#state ⇒ :present, ...

Returns State of the server.

Returns:

  • (:present, :absent, :restarted, :reinstalled, :started, :stopped, nil) —

    State of the server.



69
 
# File 'lib/ansible/ruby/modules/generated/cloud/vultr/vr_server.rb', line 69

attribute :state

#tag ⇒ Object?

Returns Tag for the server.

Returns:

  • (Object, nil) —

    Tag for the server.



50
 
# File 'lib/ansible/ruby/modules/generated/cloud/vultr/vr_server.rb', line 50

attribute :tag

#user_data ⇒ Object?

Returns User data to be passed to the server.

Returns:

  • (Object, nil) —

    User data to be passed to the server.



53
 
# File 'lib/ansible/ruby/modules/generated/cloud/vultr/vr_server.rb', line 53

attribute :user_data