Class: Ansible::Ruby::Modules::Azure_rm_virtualmachine_scaleset

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

Overview

Create and update a virtual machine scale set.

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

#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.



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

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.



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

attribute :admin_username

#capacity ⇒ Integer

Returns Capacity of VMSS.

Returns:

  • (Integer) —

    Capacity of VMSS.



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

attribute :capacity

#data_disks ⇒ Array<Hash>, ...

Returns Describes list of data disks.

Returns:

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

    Describes list of data disks.



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

attribute :data_disks

#enable_accelerated_networking ⇒ Symbol?

Returns Indicates whether user wants to allow accelerated networking for virtual machines in scaleset being created.

Returns:

  • (Symbol, nil) —

    Indicates whether user wants to allow accelerated networking for virtual machines in scaleset being created.



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

attribute :enable_accelerated_networking

#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



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

attribute :image

#load_balancer ⇒ Object?

Returns Load balancer name.

Returns:

  • (Object, nil) —

    Load balancer name.



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

attribute :load_balancer

#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.



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

attribute :location

#managed_disk_type ⇒ :Standard_LRS, ...

Returns Managed disk type.

Returns:

  • (:Standard_LRS, :Premium_LRS, nil) —

    Managed disk type.



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

attribute :managed_disk_type

#name ⇒ String

Returns Name of the virtual machine.

Returns:

  • (String) —

    Name of the virtual machine.



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

attribute :name

#os_disk_caching ⇒ :ReadOnly, ...

Returns Type of OS disk caching.

Returns:

  • (:ReadOnly, :ReadWrite, nil) —

    Type of OS disk caching.



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

attribute :os_disk_caching

#os_type ⇒ :Windows, ...

Returns Base type of operating system.

Returns:

  • (:Windows, :Linux, nil) —

    Base type of operating system.



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

attribute :os_type

#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.



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

attribute :remove_on_absent

#resource_group ⇒ String

Returns Name of the resource group containing the virtual machine scale set.

Returns:

  • (String) —

    Name of the resource group containing the virtual machine scale set.



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

attribute :resource_group

#security_group ⇒ Object?

Returns Existing security group with which to associate the subnet.,It can be the security group name which is in the same resource group.,It can be the resource Id.,It can be a dict which contains C(name) and C(resource_group) of the security group.

Returns:

  • (Object, nil) —

    Existing security group with which to associate the subnet.,It can be the security group name which is in the same resource group.,It can be the resource Id.,It can be a dict which contains C(name) and C(resource_group) of the security group.



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

attribute :security_group

#short_hostname ⇒ Object?

Returns Short host name.

Returns:

  • (Object, nil) —

    Short host name



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

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.



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

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.



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

attribute :ssh_public_keys

#state ⇒ :absent, ...

Returns Assert the state of the virtual machine scale set.,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. state.,State ‘absent’ will remove the virtual machine scale set.

Returns:

  • (:absent, :present, nil) —

    Assert the state of the virtual machine scale set.,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. state.,State ‘absent’ will remove the virtual machine scale set.



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

attribute :state

#subnet_name ⇒ String?

Returns Subnet name.

Returns:

  • (String, nil) —

    Subnet name.



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

attribute :subnet_name

#tier ⇒ :Basic, ...

Returns SKU Tier.

Returns:

  • (:Basic, :Standard, nil) —

    SKU Tier.



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

attribute :tier

#upgrade_policy ⇒ :Manual, ...

Returns Upgrade policy.

Returns:

  • (:Manual, :Automatic, nil) —

    Upgrade policy.



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

attribute :upgrade_policy

#virtual_network_name ⇒ String?

Returns Virtual Network name.

Returns:

  • (String, nil) —

    Virtual Network name.



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

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.



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

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.

Returns:

  • (String) —

    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.



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

attribute :vm_size