Class: Ansible::Ruby::Modules::Azure_rm_virtualmachine

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

Overview

Create, update, stop and start a virtual machine. Provide an existing storage account and network interface or allow the module to create these for you. If you choose not to provide a network interface, the resource group must contain a virtual network with at least one subnet. Before Ansible 2.5, this required an image found in the Azure Marketplace which can be discovered with M(azure_rm_virtualmachineimage_facts). In Ansible 2.5 and newer, custom images can be used as well, see the examples for more details.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#accept_terms ⇒ Symbol?

Returns Accept terms for marketplace images that require it,Only Azure service admin/account admin users can purchase images from the marketplace.

Returns:

  • (Symbol, nil) —

    Accept terms for marketplace images that require it,Only Azure service admin/account admin users can purchase images from the marketplace



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

attribute :accept_terms

#admin_password ⇒ String?

Returns Password for the admin username. Not required if the os_type is Linux and SSH password authentication is disabled by setting ssh_password_enabled to false.

Returns:

  • (String, nil) —

    Password for the admin username. Not required if the os_type is Linux and SSH password authentication is disabled by setting ssh_password_enabled to false.



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

attribute :admin_password

#admin_username ⇒ String?

Returns Admin username used to access the host after it is created. Required when creating a VM.

Returns:

  • (String, nil) —

    Admin username used to access the host after it is created. Required when creating a VM.



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

attribute :admin_username

#allocated ⇒ Boolean?

Returns Toggle that controls if the machine is allocated/deallocated, only useful with state=‘present’.

Returns:

  • (Boolean, nil) —

    Toggle that controls if the machine is allocated/deallocated, only useful with state=‘present’.



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

attribute :allocated

#availability_set ⇒ String?

Returns Name or ID of an existing availability set to add the VM to. The availability_set should be in the same resource group as VM.

Returns:

  • (String, nil) —

    Name or ID of an existing availability set to add the VM to. The availability_set should be in the same resource group as VM.



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

attribute :availability_set

#custom_data ⇒ Object?

Returns Data which is made available to the virtual machine and used by e.g., cloud-init.

Returns:

  • (Object, nil) —

    Data which is made available to the virtual machine and used by e.g., cloud-init.



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

attribute :custom_data

#data_disks ⇒ Array<Hash>, ...

Returns Describes list of data disks.

Returns:

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

    Describes list of data disks.



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

attribute :data_disks

#image ⇒ Hash, String

Returns Specifies the image used to build the VM.,If a string, the image is sourced from a custom image based on the name.,If a dict with the keys C(publisher), C(offer), C(sku), and C(version), the image is sourced from a Marketplace image. NOTE: set image.version to C(latest) to get the most recent version of a given image.,If a dict with the keys C(name) and C(resource_group), the image is sourced from a custom image based on the C(name) and C(resource_group) set. NOTE: the key C(resource_group) is optional and if omitted, all images in the subscription will be searched for by C(name).,Custom image support was added in Ansible 2.5.

Returns:

  • (Hash, String) —

    Specifies the image used to build the VM.,If a string, the image is sourced from a custom image based on the name.,If a dict with the keys C(publisher), C(offer), C(sku), and C(version), the image is sourced from a Marketplace image. NOTE: set image.version to C(latest) to get the most recent version of a given image.,If a dict with the keys C(name) and C(resource_group), the image is sourced from a custom image based on the C(name) and C(resource_group) set. NOTE: the key C(resource_group) is optional and if omitted, all images in the subscription will be searched for by C(name).,Custom image support was added in Ansible 2.5



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

attribute :image

#location ⇒ Object?

Returns Valid Azure location. Defaults to location of the resource group.

Returns:

  • (Object, nil) —

    Valid Azure location. Defaults to location of the resource group.



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

attribute :location

#managed_disk_type ⇒ :Standard_LRS, ...

Returns Managed OS disk type.

Returns:

  • (:Standard_LRS, :Premium_LRS, nil) —

    Managed OS disk type



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

attribute :managed_disk_type

#name ⇒ String

Returns Name of the virtual machine.

Returns:

  • (String) —

    Name of the virtual machine.



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

attribute :name

#network_interface_names ⇒ Object?

Returns List of existing network interface names to add to the VM.,Item can be a str of name or resource id of the network interface.,Item can also be a dict contains C(resource_group) and C(name) of the network interface.,If a network interface name is not provided when the VM is created, a default network interface will be created.,In order for the module to create a new network interface, at least one Virtual Network with one Subnet must exist.

Returns:

  • (Object, nil) —

    List of existing network interface names to add to the VM.,Item can be a str of name or resource id of the network interface.,Item can also be a dict contains C(resource_group) and C(name) of the network interface.,If a network interface name is not provided when the VM is created, a default network interface will be created.,In order for the module to create a new network interface, at least one Virtual Network with one Subnet must exist.



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

attribute :network_interface_names

#open_ports ⇒ Object?

Returns If a network interface is created when creating the VM, a security group will be created as well. For Linux hosts a rule will be added to the security group allowing inbound TCP connections to the default SSH port 22, and for Windows hosts ports 3389 and 5986 will be opened. Override the default open ports by providing a list of ports.

Returns:

  • (Object, nil) —

    If a network interface is created when creating the VM, a security group will be created as well. For Linux hosts a rule will be added to the security group allowing inbound TCP connections to the default SSH port 22, and for Windows hosts ports 3389 and 5986 will be opened. Override the default open ports by providing a list of ports.



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

attribute :open_ports

#os_disk_caching ⇒ :ReadOnly, ...

Returns Type of OS disk caching.

Returns:

  • (:ReadOnly, :ReadWrite, nil) —

    Type of OS disk caching.



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

attribute :os_disk_caching

#os_disk_size_gb ⇒ Integer?

Returns Type of OS disk size in GB.

Returns:

  • (Integer, nil) —

    Type of OS disk size in GB.



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

attribute :os_disk_size_gb

#os_type ⇒ :Windows, ...

Returns Base type of operating system.

Returns:

  • (:Windows, :Linux, nil) —

    Base type of operating system.



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

attribute :os_type

#plan ⇒ Hash?

Returns A dictionary describing a third-party billing plan for an instance.

Returns:

  • (Hash, nil) —

    A dictionary describing a third-party billing plan for an instance



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

attribute :plan

#public_ip_allocation_method ⇒ :Dynamic, ...

Returns If a public IP address is created when creating the VM (because a Network Interface was not provided), determines if the public IP address remains permanently associated with the Network Interface. If set to ‘Dynamic’ the public IP address may change any time the VM is rebooted or power cycled.,The C(Disabled) choice was added in Ansible 2.6.

Returns:

  • (:Dynamic, :Static, :Disabled, nil) —

    If a public IP address is created when creating the VM (because a Network Interface was not provided), determines if the public IP address remains permanently associated with the Network Interface. If set to ‘Dynamic’ the public IP address may change any time the VM is rebooted or power cycled.,The C(Disabled) choice was added in Ansible 2.6.



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

attribute :public_ip_allocation_method

#remove_on_absent ⇒ String?

Returns When removing a VM using state ‘absent’, also remove associated resources,It can be ‘all’ or a list with any of the following: [‘network_interfaces’, ‘virtual_storage’, ‘public_ips’],Any other input will be ignored.

Returns:

  • (String, nil) —

    When removing a VM using state ‘absent’, also remove associated resources,It can be ‘all’ or a list with any of the following: [‘network_interfaces’, ‘virtual_storage’, ‘public_ips’],Any other input will be ignored



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

attribute :remove_on_absent

#resource_group ⇒ String, NilClass

Returns Name of the resource group containing the virtual machine.

Returns:

  • (String, NilClass) —

    Name of the resource group containing the virtual machine.



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

attribute :resource_group

#restarted ⇒ Symbol?

Returns Use with state ‘present’ to restart a running VM.

Returns:

  • (Symbol, nil) —

    Use with state ‘present’ to restart a running VM.



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

attribute :restarted

#short_hostname ⇒ Object?

Returns Name assigned internally to the host. On a linux VM this is the name returned by the ‘hostname` command. When creating a virtual machine, short_hostname defaults to name.

Returns:

  • (Object, nil) —

    Name assigned internally to the host. On a linux VM this is the name returned by the ‘hostname` command. When creating a virtual machine, short_hostname defaults to name.



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

attribute :short_hostname

#ssh_password_enabled ⇒ Boolean?

Returns When the os_type is Linux, setting ssh_password_enabled to false will disable SSH password authentication and require use of SSH keys.

Returns:

  • (Boolean, nil) —

    When the os_type is Linux, setting ssh_password_enabled to false will disable SSH password authentication and require use of SSH keys.



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

attribute :ssh_password_enabled

#ssh_public_keys ⇒ Array<Hash>, ...

Returns For os_type Linux provide a list of SSH keys. Each item in the list should be a dictionary where the dictionary contains two keys: path and key_data. Set the path to the default location of the authorized_keys files. On an Enterprise Linux host, for example, the path will be /home/<admin username>/.ssh/authorized_keys. Set key_data to the actual value of the public key.

Returns:

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

    For os_type Linux provide a list of SSH keys. Each item in the list should be a dictionary where the dictionary contains two keys: path and key_data. Set the path to the default location of the authorized_keys files. On an Enterprise Linux host, for example, the path will be /home/<admin username>/.ssh/authorized_keys. Set key_data to the actual value of the public key.



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

attribute :ssh_public_keys

#started ⇒ Boolean?

Returns Use with state ‘present’ to start the machine. Set to false to have the machine be ‘stopped’.

Returns:

  • (Boolean, nil) —

    Use with state ‘present’ to start the machine. Set to false to have the machine be ‘stopped’.



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

attribute :started

#state ⇒ :absent, ...

Returns Assert the state of the virtual machine.,State ‘present’ will check that the machine exists with the requested configuration. If the configuration of the existing machine does not match, the machine will be updated. Use options started, allocated and restarted to change the machine’s power state.,State ‘absent’ will remove the virtual machine.

Returns:

  • (:absent, :present, nil) —

    Assert the state of the virtual machine.,State ‘present’ will check that the machine exists with the requested configuration. If the configuration of the existing machine does not match, the machine will be updated. Use options started, allocated and restarted to change the machine’s power state.,State ‘absent’ will remove the virtual machine.



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

attribute :state

#storage_account_name ⇒ Object?

Returns Name of an existing storage account that supports creation of VHD blobs. If not specified for a new VM, a new storage account named <vm name>01 will be created using storage type ‘Standard_LRS’.

Returns:

  • (Object, nil) —

    Name of an existing storage account that supports creation of VHD blobs. If not specified for a new VM, a new storage account named <vm name>01 will be created using storage type ‘Standard_LRS’.



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

attribute :storage_account_name

#storage_blob_name ⇒ Object?

Returns Name fo the storage blob used to hold the VM’s OS disk image. If no name is provided, defaults to the VM name + ‘.vhd’. If you provide a name, it must end with ‘.vhd’.

Returns:

  • (Object, nil) —

    Name fo the storage blob used to hold the VM’s OS disk image. If no name is provided, defaults to the VM name + ‘.vhd’. If you provide a name, it must end with ‘.vhd’



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

attribute :storage_blob_name

#storage_container_name ⇒ String?

Returns Name of the container to use within the storage account to store VHD blobs. If no name is specified a default container will created.

Returns:

  • (String, nil) —

    Name of the container to use within the storage account to store VHD blobs. If no name is specified a default container will created.



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

attribute :storage_container_name

#subnet_name ⇒ Object?

Returns When creating a virtual machine, if a network interface name is not provided, one will be created.,The new network interface will be assigned to the first subnet found in the virtual network.,Use this parameter to provide a specific subnet instead.,If the subnet is in another resource group, specific resource group by C(virtual_network_resource_group).

Returns:

  • (Object, nil) —

    When creating a virtual machine, if a network interface name is not provided, one will be created.,The new network interface will be assigned to the first subnet found in the virtual network.,Use this parameter to provide a specific subnet instead.,If the subnet is in another resource group, specific resource group by C(virtual_network_resource_group).



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

attribute :subnet_name

#virtual_network_name ⇒ Object?

Returns When creating a virtual machine, if a network interface name is not provided, one will be created.,The network interface will be assigned to the first virtual network found in the resource group.,Use this parameter to provide a specific virtual network instead.,If the virtual network in in another resource group, specific resource group by C(virtual_network_resource_group).

Returns:

  • (Object, nil) —

    When creating a virtual machine, if a network interface name is not provided, one will be created.,The network interface will be assigned to the first virtual network found in the resource group.,Use this parameter to provide a specific virtual network instead.,If the virtual network in in another resource group, specific resource group by C(virtual_network_resource_group).



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

attribute :virtual_network_name

#virtual_network_resource_group ⇒ Object?

Returns When creating a virtual machine, if a specific virtual network from another resource group should be used, use this parameter to specify the resource group to use.

Returns:

  • (Object, nil) —

    When creating a virtual machine, if a specific virtual network from another resource group should be used, use this parameter to specify the resource group to use.



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

attribute :virtual_network_resource_group

#vm_size ⇒ String?

Returns A valid Azure VM size value. For example, ‘Standard_D4’. The list of choices varies depending on the subscription and location. Check your subscription for available choices. Required when creating a VM.

Returns:

  • (String, nil) —

    A valid Azure VM size value. For example, ‘Standard_D4’. The list of choices varies depending on the subscription and location. Check your subscription for available choices. Required when creating a VM.



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

attribute :vm_size