archive
/
ansible
mirror of https://github.com/ansible/ansible.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update azure_rm_virtualmachinescaleset related document (#58699)

Browse Source
pull/58911/head
Fred-sun 5 years ago committed by Alicia Cozine
parent 612223773a
commit de7776e25d
2 changed files with 61 additions and 58 deletions
Show Stats Download Patch File Download Diff File

74
lib/ansible/modules/cloud/azure/azure_rm_virtualmachinescaleset.py
Unescape Escape View File

@ -19,13 +19,11 @@ module: azure_rm_virtualmachinescaleset
version_added: "2.4" version_added: "2.4"
short_description: Manage Azure virtual machine scale sets. short_description: Manage Azure virtual machine scale sets
description: description:
- Create and update a virtual machine scale set. - Create and update a virtual machine scale set.
- Note that this module was called M(azure_rm_virtualmachine_scaleset) before Ansible 2.8. The usage did not change.
notes:
- This module was called C(azure_rm_virtualmachine_scaleset) before Ansible 2.8. The usage did not change.
options: options:
resource_group: resource_group:
@ -41,7 +39,6 @@ options:
- Assert the state of the virtual machine scale set. - Assert the state of the virtual machine scale set.
- State C(present) will check that the machine exists with the requested configuration. If the configuration - State C(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. of the existing machine does not match, the machine will be updated.
state.
- State C(absent) will remove the virtual machine scale set. - State C(absent) will remove the virtual machine scale set.
default: present default: present
choices: choices:
@ -52,11 +49,11 @@ options:
- Valid Azure location. Defaults to location of the resource group. - Valid Azure location. Defaults to location of the resource group.
short_hostname: short_hostname:
description: description:
- Short host name - Short host name.
vm_size: vm_size:
description: description:
- A valid Azure VM size value. For example, 'Standard_D4'. The list of choices varies depending on the - A valid Azure VM size value. For example, C(Standard_D4).
subscription and location. Check your subscription for available choices. - The list of choices varies depending on the subscription and location. Check your subscription for available choices.
capacity: capacity:
description: description:
- Capacity of VMSS. - Capacity of VMSS.
@ -79,35 +76,29 @@ options:
- Admin username used to access the host after it is created. Required when creating a VM. - Admin username used to access the host after it is created. Required when creating a VM.
admin_password: admin_password:
description: description:
- Password for the admin username. Not required if the os_type is Linux and SSH password authentication - Password for the admin username.
is disabled by setting ssh_password_enabled to false. - Not required if the os_type is Linux and SSH password authentication is disabled by setting I(ssh_password_enabled=false).
ssh_password_enabled: ssh_password_enabled:
description: description:
- When the os_type is Linux, setting ssh_password_enabled to false will disable SSH password authentication - When the os_type is Linux, setting I(ssh_password_enabled=false) will disable SSH password authentication and require use of SSH keys.
and require use of SSH keys.
type: bool type: bool
default: true default: true
ssh_public_keys: ssh_public_keys:
description: description:
- "For os_type Linux provide a list of SSH keys. Each item in the list should be a dictionary where the - For I(os_type=Linux) provide a list of SSH keys.
dictionary contains two keys: path and key_data. Set the path to the default location of the - Each item in the list should be a dictionary where the dictionary contains two keys, C(path) and C(key_data).
authorized_keys files. On an Enterprise Linux host, for example, the path will be - Set the C(path) to the default location of the authorized_keys files.
/home/<admin username>/.ssh/authorized_keys. Set key_data to the actual value of the public key." - On an Enterprise Linux host, for example, the I(path=/home/<admin username>/.ssh/authorized_keys).
Set C(key_data) to the actual value of the public key.
image: image:
description: description:
- Specifies the image used to build the VM. - Specifies the image used to build the VM.
- If a string, the image is sourced from a custom image based on the - If a string, the image is sourced from a custom image based on the name.
name. - If a dict with the keys I(publisher), I(offer), I(sku), and I(version), the image is sourced from a Marketplace image.
- 'If a dict with the keys C(publisher), C(offer), C(sku), and Note that set I(version=latest) to get the most recent version of a given image.
C(version), the image is sourced from a Marketplace image. NOTE: - If a dict with the keys I(name) and I(resource_group), the image is sourced from a custom image based on the I(name) and I(resource_group) set.
set image.version to C(latest) to get the most recent version of a Note that the key I(resource_group) is optional and if omitted, all images in the subscription will be searched for by I(name).
given image.' - Custom image support was added in Ansible 2.5.
- '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
required: true required: true
os_disk_caching: os_disk_caching:
description: description:
@ -163,7 +154,8 @@ options:
virtual_network_resource_group: virtual_network_resource_group:
description: description:
- When creating a virtual machine, if a specific virtual network from another resource group should be - 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. used.
- Use this parameter to specify the resource group to use.
version_added: "2.5" version_added: "2.5"
virtual_network_name: virtual_network_name:
description: description:
@ -185,8 +177,8 @@ options:
version_added: "2.8" version_added: "2.8"
remove_on_absent: remove_on_absent:
description: description:
- When removing a VM using state 'absent', also remove associated resources. - When removing a VM using I(state=absent), also remove associated resources.
- "It can be 'all' or a list with any of the following: ['network_interfaces', 'virtual_storage', 'public_ips']." - It can be C(all) or a list with any of the following ['network_interfaces', 'virtual_storage', 'public_ips'].
- Any other input will be ignored. - Any other input will be ignored.
default: ['all'] default: ['all']
enable_accelerated_networking: enable_accelerated_networking:
@ -198,8 +190,8 @@ options:
description: description:
- Existing security group with which to associate the subnet. - 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 security group name which is in the same resource group.
- It can be the resource Id. - It can be the resource ID.
- It can be a dict which contains C(name) and C(resource_group) of the security group. - It can be a dict which contains I(name) and I(resource_group) of the security group.
version_added: "2.7" version_added: "2.7"
aliases: aliases:
- security_group_name - security_group_name
@ -222,9 +214,9 @@ options:
version_added: "2.8" version_added: "2.8"
custom_data: custom_data:
description: description:
- Data which is made available to the virtual machine and used by e.g., cloud-init. - Data which is made available to the virtual machine and used by e.g., C(cloud-init).
- Many images in the marketplace are not cloud-init ready. Thus, data - Many images in the marketplace are not cloud-init ready. Thus, data sent to I(custom_data) would be ignored.
sent to I(custom_data) would be ignored. If the image you are attempting to use is not listed in - If the image you are attempting to use is not listed in
U(https://docs.microsoft.com/en-us/azure/virtual-machines/linux/using-cloud-init#cloud-init-overview), U(https://docs.microsoft.com/en-us/azure/virtual-machines/linux/using-cloud-init#cloud-init-overview),
follow these steps U(https://docs.microsoft.com/en-us/azure/virtual-machines/linux/cloudinit-prepare-custom-image). follow these steps U(https://docs.microsoft.com/en-us/azure/virtual-machines/linux/cloudinit-prepare-custom-image).
version_added: "2.8" version_added: "2.8"
@ -234,7 +226,7 @@ extends_documentation_fragment:
- azure_tags - azure_tags
author: author:
- "Sertac Ozercan (@sozercan)" - Sertac Ozercan (@sozercan)
''' '''
EXAMPLES = ''' EXAMPLES = '''
@ -313,10 +305,12 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
azure_vmss: azure_vmss:
description: Facts about the current state of the object. Note that facts are not part of the registered output but available directly. description:
- Facts about the current state of the object.
- Note that facts are not part of the registered output but available directly.
returned: always returned: always
type: complex type: dict
contains: { sample: {
"properties": { "properties": {
"overprovision": true, "overprovision": true,
"singlePlacementGroup": true, "singlePlacementGroup": true,

45
lib/ansible/modules/cloud/azure/azure_rm_virtualmachinescaleset_facts.py
Unescape Escape View File

@ -20,26 +20,24 @@ version_added: "2.4"
short_description: Get Virtual Machine Scale Set facts short_description: Get Virtual Machine Scale Set facts
description: description:
- Get facts for a virtual machine scale set - Get facts for a virtual machine scale set.
- Note that this module was called M(azure_rm_virtualmachine_scaleset_facts) before Ansible 2.8. The usage did not change.
notes:
- This module was called C(azure_rm_virtualmachine_scaleset_facts) before Ansible 2.8. The usage did not change.
options: options:
name: name:
description: description:
- Limit results to a specific virtual machine scale set - Limit results to a specific virtual machine scale set.
resource_group: resource_group:
description: description:
- The resource group to search for the desired virtual machine scale set - The resource group to search for the desired virtual machine scale set.
tags: tags:
description: description:
- List of tags to be matched - List of tags to be matched.
format: format:
description: description:
- Format of the data returned. - Format of the data returned.
- If C(raw) is selected information will be returned in raw format from Azure Python SDK. - If C(raw) is selected information will be returned in raw format from Azure Python SDK.
- If C(curated) is selected the structure will be identical to input parameters of azure_rm_virtualmachinescaleset module. - If C(curated) is selected the structure will be identical to input parameters of M(azure_rm_virtualmachinescaleset) module.
- In Ansible 2.5 and lower facts are always returned in raw format. - In Ansible 2.5 and lower facts are always returned in raw format.
- Please note that this option will be deprecated in 2.10 when curated format will become the only supported format. - Please note that this option will be deprecated in 2.10 when curated format will become the only supported format.
default: 'raw' default: 'raw'
@ -52,7 +50,7 @@ extends_documentation_fragment:
- azure - azure
author: author:
- "Sertac Ozercan (@sozercan)" - Sertac Ozercan (@sozercan)
''' '''
EXAMPLES = ''' EXAMPLES = '''
@ -75,13 +73,14 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
vmss: vmss:
description: List of virtual machine scale sets description:
- List of virtual machine scale sets.
returned: always returned: always
type: complex type: complex
contains: contains:
id: id:
description: description:
- Resource ID - Resource ID.
returned: always returned: always
type: str type: str
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/scalesets/myscaleset sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/scalesets/myscaleset
@ -106,47 +105,55 @@ vmss:
caching: caching:
description: description:
- Type of data disk caching. - Type of data disk caching.
returned: always
type: str type: str
sample: ReadOnly sample: ReadOnly
disk_size_gb: disk_size_gb:
description: description:
- The initial disk size in GB for blank data disks - The initial disk size in GB for blank data disks.
returned: always
type: int type: int
sample: 64 sample: 64
lun: lun:
description: description:
- The logical unit number for data disk - The logical unit number for data disk.
returned: always
type: int type: int
sample: 0 sample: 0
managed_disk_type: managed_disk_type:
description: description:
- Managed data disk type - Managed data disk type.
returned: always
type: str type: str
sample: Standard_LRS sample: Standard_LRS
image: image:
description: description:
- Image specification - Image specification.
returned: always returned: always
type: complex type: complex
contains: contains:
offer: offer:
description: description:
- Offer. - The offer of the platform image or marketplace image used to create the virtual machine.
returned: always
type: str type: str
sample: RHEL sample: RHEL
publisher: publisher:
description: description:
- Publisher name. - Publisher name.
returned: always
type: str type: str
sample: RedHat sample: RedHat
sku: sku:
description: description:
- SKU name. - SKU name.
returned: always
type: str type: str
sample: 7-RAW sample: 7-RAW
version: version:
description: description:
- Image version. - Image version.
returned: always
type: str type: str
sample: 7.5.2018050901 sample: 7.5.2018050901
load_balancer: load_balancer:
@ -163,7 +170,7 @@ vmss:
sample: japaneast sample: japaneast
managed_disk_type: managed_disk_type:
description: description:
- Managed data disk type - Managed data disk type.
type: str type: str
returned: always returned: always
sample: Standard_LRS sample: Standard_LRS
@ -233,7 +240,9 @@ vmss:
returned: always returned: always
sample: Standard_D4 sample: Standard_D4
tags: tags:
description: Tags assigned to the resource. Dictionary of string:string pairs. description:
- Tags assigned to the resource. Dictionary of string:string pairs.
returned: always
type: dict type: dict
sample: { "tag1": "abc" } sample: { "tag1": "abc" }
''' # NOQA ''' # NOQA

Write Preview
Loading…
Cancel
Save