Class: Ansible::Ruby::Modules::Azure

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Azure

Defined in:

lib/ansible/ruby/modules/generated/cloud/azure/azure.rb

Overview

Creates or terminates azure instances. When created optionally waits for it to be ‘running’.

Instance Method Summary

• #auto_updates ⇒ :yes, ...

  Enable Auto Updates on Windows Machines.

• #enable_winrm ⇒ :yes, ...

  Enable winrm on Windows Machines.

• #endpoints ⇒ Integer^?

  A comma-separated list of TCP ports to expose on the virtual machine (e.g., “22,80”).

• #hostname ⇒ String^?

  Hostname to write /etc/hostname.

• #image ⇒ String

  System image for creating the virtual machine (e.g., b39f27a8b8c64d52b05eac6a62ebad85__Ubuntu_DAILY_BUILD-precise-12_04_3-LTS-amd64-server-20131205-en-us-30GB).

• #location ⇒ String

  The azure location to use (e.g. ‘East US’).

• #management_cert_path ⇒ String^?

  Path to an azure management certificate associated with the subscription id.

• #name ⇒ String

  Name of the virtual machine and associated cloud service.

• #os_type ⇒ :windows, ...

  The type of the os that is gettings provisioned.

• #password ⇒ String^?

  The unix password for the new virtual machine.

• #role_size ⇒ String^?

  Azure role size for the new virtual machine (e.g., Small, ExtraLarge, A6).

• #ssh_cert_path ⇒ String^?

  Path to an X509 certificate containing the public ssh key to install in the virtual machine.

• #state ⇒ :absent, ...

  Create or terminate instances.

• #storage_account ⇒ String

  The azure storage account in which to store the data disks.

• #subscription_id ⇒ String^?

  Azure subscription id.

• #user ⇒ String^?

  The unix username for the new virtual machine.

• #virtual_network_name ⇒ String^?

  Name of virtual network.

• #wait ⇒ :yes, ...

  Wait for the instance to be in state ‘running’ before returning.

• #wait_timeout ⇒ Integer^?

  How long before wait gives up, in seconds.

• #wait_timeout_redirects ⇒ Integer^?

  How long before wait gives up for redirects, in seconds.

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_updates ⇒ :yes, ...

Returns Enable Auto Updates on Windows Machines.

Returns:

• (:yes, :no, nil) —

  Enable Auto Updates on Windows Machines

# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure.rb', line 80

attribute :auto_updates

#enable_winrm ⇒ :yes, ...

Returns Enable winrm on Windows Machines.

Returns:

• (:yes, :no, nil) —

  Enable winrm on Windows Machines

# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure.rb', line 84

attribute :enable_winrm

#endpoints ⇒ Integer^?

Returns a comma-separated list of TCP ports to expose on the virtual machine (e.g., “22,80”).

Returns:

• (Integer, nil) —

  a comma-separated list of TCP ports to expose on the virtual machine (e.g., “22,80”)

# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure.rb', line 40

attribute :endpoints

#hostname ⇒ String^?

Returns hostname to write /etc/hostname. Defaults to <name>.cloudapp.net.

Returns:

• (String, nil) —

  hostname to write /etc/hostname. Defaults to <name>.cloudapp.net.

# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure.rb', line 60

attribute :hostname

#image ⇒ String

Returns system image for creating the virtual machine (e.g., b39f27a8b8c64d52b05eac6a62ebad85__Ubuntu_DAILY_BUILD-precise-12_04_3-LTS-amd64-server-20131205-en-us-30GB).

Returns:

• (String) —

  system image for creating the virtual machine (e.g., b39f27a8b8c64d52b05eac6a62ebad85__Ubuntu_DAILY_BUILD-precise-12_04_3-LTS-amd64-server-20131205-en-us-30GB)

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

attribute :image

#location ⇒ String

Returns the azure location to use (e.g. ‘East US’).

Returns:

• (String) —

  the azure location to use (e.g. ‘East US’)

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

attribute :location

#management_cert_path ⇒ String^?

Returns path to an azure management certificate associated with the subscription id. Overrides the AZURE_CERT_PATH environment variable.

Returns:

• (String, nil) —

  path to an azure management certificate associated with the subscription id. Overrides the AZURE_CERT_PATH environment variable.

# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure.rb', line 24

attribute :management_cert_path

#name ⇒ String

Returns name of the virtual machine and associated cloud service.

Returns:

• (String) —

  name of the virtual machine and associated cloud service.

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

attribute :name

#os_type ⇒ :windows, ...

Returns The type of the os that is gettings provisioned.

Returns:

• (:windows, :linux, nil) —

  The type of the os that is gettings provisioned

# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure.rb', line 88

attribute :os_type

#password ⇒ String^?

Returns the unix password for the new virtual machine.

Returns:

• (String, nil) —

  the unix password for the new virtual machine.

# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure.rb', line 48

attribute :password

#role_size ⇒ String^?

Returns azure role size for the new virtual machine (e.g., Small, ExtraLarge, A6). You have to pay attention to the fact that instances of type G and DS are not available in all regions (locations). Make sure if you selected the size and type of instance available in your chosen location.

Returns:

• (String, nil) —

  azure role size for the new virtual machine (e.g., Small, ExtraLarge, A6). You have to pay attention to the fact that instances of type G and DS are not available in all regions (locations). Make sure if you selected the size and type of instance available in your chosen location.

# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure.rb', line 36

attribute :role_size

#ssh_cert_path ⇒ String^?

Returns path to an X509 certificate containing the public ssh key to install in the virtual machine. See www.windowsazure.com/en-us/manage/linux/tutorials/intro-to-linux/ for more details.,if this option is specified, password-based ssh authentication will be disabled.

Returns:

• (String, nil) —

  path to an X509 certificate containing the public ssh key to install in the virtual machine. See www.windowsazure.com/en-us/manage/linux/tutorials/intro-to-linux/ for more details.,if this option is specified, password-based ssh authentication will be disabled.

# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure.rb', line 52

attribute :ssh_cert_path

#state ⇒ :absent, ...

Returns create or terminate instances.

Returns:

• (:absent, :present, nil) —

  create or terminate instances

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

attribute :state

#storage_account ⇒ String

Returns the azure storage account in which to store the data disks.

Returns:

• (String) —

  the azure storage account in which to store the data disks.

# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure.rb', line 28

attribute :storage_account

#subscription_id ⇒ String^?

Returns azure subscription id. Overrides the AZURE_SUBSCRIPTION_ID environment variable.

Returns:

• (String, nil) —

  azure subscription id. Overrides the AZURE_SUBSCRIPTION_ID environment variable.

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

attribute :subscription_id

#user ⇒ String^?

Returns the unix username for the new virtual machine.

Returns:

• (String, nil) —

  the unix username for the new virtual machine.

# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure.rb', line 44

attribute :user

#virtual_network_name ⇒ String^?

Returns Name of virtual network.

Returns:

• (String, nil) —

  Name of virtual network.

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

attribute :virtual_network_name

#wait ⇒ :yes, ...

Returns wait for the instance to be in state ‘running’ before returning.

Returns:

• (:yes, :no, nil) —

  wait for the instance to be in state ‘running’ before returning

# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure.rb', line 64

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

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

attribute :wait_timeout

#wait_timeout_redirects ⇒ Integer^?

Returns how long before wait gives up for redirects, in seconds.

Returns:

• (Integer, nil) —

  how long before wait gives up for redirects, in seconds

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

attribute :wait_timeout_redirects