azure.azcollection.azure_rm_virtualmachine_info module – Get virtual machine facts
Note
This module is part of the azure.azcollection collection (version 2.7.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install azure.azcollection
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: azure.azcollection.azure_rm_virtualmachine_info
.
New in azure.azcollection 0.1.2
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
The host that executes this module must have the azure.azcollection collection installed via galaxy
All python packages listed in collection’s requirements.txt must be installed via pip on the host that executes modules from azure.azcollection
Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection
Parameters
Parameter |
Comments |
---|---|
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. |
|
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. |
|
Selects an API profile to use when communicating with Azure services. Default value of Default: |
|
Controls the source of the credentials to use for authentication. Can also be set via the When set to When set to When set to When set to When set to The Choices:
|
|
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 Choices:
|
|
Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi). Can also be set via the |
|
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, Default: |
|
Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to **True**, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy. Set via credential file profile or the Choices:
|
|
Parent argument. |
|
Parent argument. |
|
Name of the virtual machine. |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Security profile found in ~/.azure/credentials file. |
|
Name of the resource group containing the virtual machines (required when filtering by vm name). |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
Your Azure subscription Id. |
|
Limit results by providing a list of tags. Format tags as ‘key’ or ‘key:value’. |
|
Azure tenant ID. Use when authenticating with a Service Principal. |
|
The thumbprint of the private key specified in x509_certificate_path. Use when authenticating with a Service Principal. Required if x509_certificate_path is defined. |
|
Path to the X509 certificate used to create the service principal in PEM format. The certificate must be appended to the private key. 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
azure_rm_virtualmachine_info:
resource_group: myResourceGroup
- name: Get facts by name
azure_rm_virtualmachine_info:
resource_group: myResourceGroup
name: myVm
- name: Get facts by tags
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 |
Description |
---|---|
List of virtual machines. Returned: always |
|
Enables or disables a capability on the virtual machine. Returned: always Sample: |
|
Administrator user name. Returned: always Sample: |
|
Information about the boot diagnostics settings. Returned: always |
|
Contains a URI to grab a console screenshot. Only present if enabled. Returned: always Sample: |
|
Indicates if boot diagnostics are enabled. Returned: always Sample: |
|
Contains a URI to grab the serial console log. Only present if enabled. Returned: always Sample: |
|
Indicates the storage account used by boot diagnostics. Returned: always Sample: |
|
The name or ID of the capacity reservation group to be associated with. Returned: always Sample: |
|
List of attached data disks. Returned: always |
|
Type of data disk caching. Returned: always Sample: |
|
The initial disk size in GB for blank data disks. Returned: always Sample: |
|
The logical unit number for data disk. Returned: always Sample: |
|
Managed data disk ID. Returned: always Sample: |
|
Managed data disk type. Returned: always Sample: |
|
The short localizable label for the status. Returned: always Sample: |
|
Resource ID. Returned: always Sample: |
|
Image specification. Returned: always |
|
Custom image resource ID. Returned: when created from custom image Sample: |
|
The offer of the platform image or marketplace image used to create the virtual machine. Returned: when created from marketplace image Sample: |
|
Publisher name. Returned: when created from marketplace image Sample: |
|
SKU name. Returned: when created from marketplace image Sample: |
|
Image version. Returned: when created from marketplace image Sample: |
|
Resource location. Returned: always Sample: |
|
Resource name. Returned: always Sample: |
|
List of attached network interfaces. Returned: always Sample: |
|
Type of OS disk caching. Returned: always Sample: |
|
Base type of operating system. Returned: always Sample: |
|
Power state of the virtual machine. Returned: always Sample: |
|
The provisioning state, which only appears in the response. Returned: always Sample: |
|
The name or ID of the proximity placement group the VM should be associated with. Returned: always Sample: |
|
Resource group. Returned: always Sample: |
|
Specifies the Security related profile settings for the virtual machine. Returned: when-used |
|
This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine. This will enable the encryption for all the disks including Resource/Temp disk at host itself. Returned: when-enabled Sample: |
|
Specifies the SecurityType of the virtual machine. It is set as TrustedLaunch to enable UefiSettings. Returned: when-enabled Sample: |
|
Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Returned: when-enabled |
|
Specifies whether secure boot should be enabled on the virtual machine. Returned: when-enabled Sample: |
|
Specifies whether vTPM should be enabled on the virtual machine. Returned: when-enabled Sample: |
|
State of the resource. Returned: always Sample: |
|
Resource tags. Returned: always Sample: |
|
Version of the Azure VM Agent (waagent) running inside the VM. Returned: always Sample: |
|
Virtual machine size. Returned: always Sample: |
|
A list of Availability Zones for your VM. Returned: success Sample: |