azure_rm_virtualmachine_facts – Get virtual machine facts.

From Get docs
Ansible/docs/2.7/modules/azure rm virtualmachine facts module


azure_rm_virtualmachine_facts – Get virtual machine facts.

New in version 2.7.


Synopsis

  • Get facts for all virtual machines of 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

-

Active Directory username. Use when authenticating with an Active Directory user rather than service principal.

adfs_authority_url

-

added in 2.6

Default:

null

Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.

api_profile

-

added in 2.5

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

-

added in 2.5

  • auto
  • cli
  • credential_file
  • env
  • msi

Controls the source of the credentials to use for authentication.

If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to auto if variable is not defined.

auto will follow the default precedence of module parameters -> environment variables -> default profile in credential file ~/.azure/credentials.

When set to cli, the credentials will be sources from the default Azure CLI profile.

Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.

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

-

added in 2.5

  • validate
  • ignore

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

-

Azure client ID. Use when authenticating with a Service Principal.

cloud_environment

-

added in 2.4

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

-

Name of the virtual machine.

password

-

Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.

profile

-

Security profile found in ~/.azure/credentials file.

resource_group

-

Name of the resource group containing the virtual machines (required when filtering by vm name).

secret

-

Azure client secret. Use when authenticating with a Service Principal.

subscription_id

-

Your Azure subscription Id.

tags

-

Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.

tenant

-

Azure tenant ID. Use when authenticating with a Service Principal.



Notes

Note

  • For authentication with Azure you can pass parameters, set environment variables or use a profile stored in ~/.azure/credentials. Authentication is 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.


Examples

- name: Get facts for all virtual machines of a resource group
  azure_rm_virtualmachine_facts:
    resource_group: Testing

- name: Get facts by name
  azure_rm_virtualmachine_facts:
    resource_group: Testing
    name: vm

- name: Get facts by tags
  azure_rm_virtualmachine_facts:
    resource_group: Testing
    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

data_disks

complex

always

List of attached data disks.


caching

string

Type of data disk caching.


Sample:

ReadOnly

disk_size_gb

integer

The initial disk size in GB for blank data disks


Sample:

64

lun

integer

The logical unit number for data disk


managed_disk_type

string

Managed data disk type


Sample:

Standard_LRS

id

string

always

Resource ID.


Sample:

/subscriptions/xxxx/resourceGroups/myclusterrg/providers/Microsoft.Compute/virtualMachines/mycluster-node-2

image

complex

always

Image specification


offer

string

Offer.


Sample:

RHEL

publisher

string

Publisher name.


Sample:

RedHat

sku

string

SKU name.


Sample:

7-RAW

version

string

Image version.


Sample:

7.5.2018050901

location

string

always

Resource location.


Sample:

japaneast

name

string

always

Resource name.


Sample:

mycluster-node-2

network_interface_names

list

List of attached network interfaces.


Sample:

['mycluster-node-2-nic']

os_disk_caching

string

Type of OS disk caching.


Sample:

ReadOnly

os_type

string

Base type of operating system.


Sample:

Linux

resource_group

string

Resource group.


state

string

State of the resource.


Sample:

present

tags

dictionary

Tags.


vm_size

string

Virtual machine size.


Sample:

Standard_D4




Status

Authors

  • Gustavo Muniz do Carmo (@gustavomcarmo)
  • Zim Kalinowski (@zikalino)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/azure_rm_virtualmachine_facts_module.html