community.azure.azure_rm_virtualmachine_info – Get virtual machine facts

Note

This plugin is part of the community.azure collection (version 1.0.0).

To install it use: ansible-galaxy collection install community.azure.

To use it in a playbook, specify: community.azure.azure_rm_virtualmachine_info.

Synopsis

  • Get facts for one or all virtual machines in a resource group.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7

  • azure >= 2.0.0

Parameters

Parameter Choices/Defaults Comments
ad_user
string
Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url
string
added in 0.0.1 of azure.azcollection
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile
string
added in 0.0.1 of azure.azcollection
Default:
"latest"
Selects an API profile to use when communicating with Azure services. Default value of latest is appropriate for public clouds; future values will allow use with Azure Stack.
auth_source
string
added in 0.0.1 of azure.azcollection
    Choices:
  • auto ←
  • cli
  • credential_file
  • env
  • msi
Controls the source of the credentials to use for authentication.
Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.
When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli.
When set to env, the credentials will be read from the environment variables
When set to credential_file, it will read the profile from ~/.azure/credentials.
When set to cli, the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used.
When set to msi, the host machine must be an azure resource with an enabled MSI extension. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen.
The msi was added in Ansible 2.6.
cert_validation_mode
string
added in 0.0.1 of azure.azcollection
    Choices:
  • ignore
  • validate
Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing ignore. Can also be set via credential file profile or the AZURE_CERT_VALIDATION environment variable.
client_id
string
Azure client ID. Use when authenticating with a Service Principal.
cloud_environment
string
added in 0.0.1 of azure.azcollection
Default:
"AzureCloud"
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, AzureChinaCloud, AzureUSGovernment), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the AZURE_CLOUD_ENVIRONMENT environment variable.
name
string
Name of the virtual machine.
password
string
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile
string
Security profile found in ~/.azure/credentials file.
resource_group
string
Name of the resource group containing the virtual machines (required when filtering by vm name).
secret
string
Azure client secret. Use when authenticating with a Service Principal.
subscription_id
string
Your Azure subscription Id.
tags
string
Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
tenant
string
Azure tenant ID. Use when authenticating with a Service Principal.

Notes

Note

  • For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with az login.

  • Authentication is also possible using a service principal or Active Directory user.

  • To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.

  • To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.

  • Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.

See Also

See also

Sign in with Azure CLI

How to authenticate using the az login command.

Examples

- name: Get facts for all virtual machines of a resource group
  community.azure.azure_rm_virtualmachine_info:
    resource_group: myResourceGroup

- name: Get facts by name
  community.azure.azure_rm_virtualmachine_info:
    resource_group: myResourceGroup
    name: myVm

- name: Get facts by tags
  community.azure.azure_rm_virtualmachine_info:
    resource_group: myResourceGroup
    tags:
      - testing
      - foo:bar

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
vms
complex
always
List of virtual machines.
 
admin_username
string
always
Administrator user name.

Sample:
admin
 
boot_diagnostics
complex
always
Information about the boot diagnostics settings.
   
console_screenshot_uri
string
always
Contains a URI to grab a console screenshot.
Only present if enabled.

Sample:
https://mystorageaccountname.blob.core.windows.net/bootdiagnostics-myvm01-a4db09a6-ab7f-4d80-9da8-fbceaef9288a/ myVm.a4db09a6-ab7f-4d80-9da8-fbceaef9288a.screenshot.bmp
   
enabled
boolean
always
Indicates if boot diagnostics are enabled.

Sample:
True
   
serial_console_log_uri
string
always
Contains a URI to grab the serial console log.
Only present if enabled.

Sample:
https://mystorageaccountname.blob.core.windows.net/bootdiagnostics-myvm01-a4db09a6-ab7f-4d80-9da8-fbceaef9288a/ myVm.a4db09a6-ab7f-4d80-9da8-fbceaef9288a.serialconsole.log
   
storage_uri
string
always
Indicates the storage account used by boot diagnostics.

Sample:
https://mystorageaccountname.blob.core.windows.net/
 
data_disks
complex
always
List of attached data disks.
   
caching
string
always
Type of data disk caching.

Sample:
ReadOnly
   
disk_size_gb
integer
always
The initial disk size in GB for blank data disks.

Sample:
64
   
lun
integer
always
The logical unit number for data disk.
   
managed_disk_type
string
always
Managed data disk type.

Sample:
Standard_LRS
 
id
string
always
Resource ID.

Sample:
/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVm
 
image
complex
always
Image specification.
   
id
string
when created from custom image
Custom image resource ID.

Sample:
/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage
   
offer
string
when created from marketplace image
The offer of the platform image or marketplace image used to create the virtual machine.

Sample:
RHEL
   
publisher
string
when created from marketplace image
Publisher name.

Sample:
RedHat
   
sku
string
when created from marketplace image
SKU name.

Sample:
7-RAW
   
version
string
when created from marketplace image
Image version.

Sample:
7.5.2018050901
 
location
string
always
Resource location.

Sample:
japaneast
 
name
string
always
Resource name.

Sample:
myVm
 
network_interface_names
list / elements=string
always
List of attached network interfaces.

Sample:
['myNetworkInterface']
 
os_disk_caching
string
always
Type of OS disk caching.

Sample:
ReadOnly
 
os_type
string
always
Base type of operating system.

Sample:
Linux
 
power_state
string
always
Power state of the virtual machine.

Sample:
running
 
resource_group
string
always
Resource group.

Sample:
myResourceGroup
 
state
string
always
State of the resource.

Sample:
present
 
tags
dictionary
always
Resource tags.

Sample:
{'key1': 'value1'}
 
vm_size
string
always
Virtual machine size.

Sample:
Standard_D4


Authors

  • Gustavo Muniz do Carmo (@gustavomcarmo)

  • Zim Kalinowski (@zikalino)