Try SpotterGet virtual machine facts
| "added in version" 0.1.2 of azure.azcollection"
Authors: Gustavo Muniz do Carmo (@gustavomcarmo), Zim Kalinowski (@zikalino)
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections:
- name: azure.azcollection
version: 2.3.0Get facts for one or all virtual machines in a resource group.
- 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
name:
description:
- Name of the virtual machine.
type: str
tags:
description:
- Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
elements: str
type: list
secret:
description:
- Azure client secret. Use when authenticating with a Service Principal.
type: str
tenant:
description:
- Azure tenant ID. Use when authenticating with a Service Principal.
type: str
ad_user:
description:
- Active Directory username. Use when authenticating with an Active Directory user
rather than service principal.
type: str
profile:
description:
- Security profile found in ~/.azure/credentials file.
type: str
log_mode:
description:
- Parent argument.
type: str
log_path:
description:
- Parent argument.
type: str
password:
description:
- Active Directory user password. Use when authenticating with an Active Directory
user rather than service principal.
type: str
client_id:
description:
- Azure client ID. Use when authenticating with a Service Principal or Managed Identity
(msi).
- Can also be set via the C(AZURE_CLIENT_ID) environment variable.
type: str
thumbprint:
description:
- The thumbprint of the private key specified in I(x509_certificate_path).
- Use when authenticating with a Service Principal.
- Required if I(x509_certificate_path) is defined.
type: str
version_added: 1.14.0
version_added_collection: azure.azcollection
api_profile:
default: latest
description:
- Selects an API profile to use when communicating with Azure services. Default value
of C(latest) is appropriate for public clouds; future values will allow use with
Azure Stack.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
auth_source:
choices:
- auto
- cli
- credential_file
- env
- msi
default: auto
description:
- Controls the source of the credentials to use for authentication.
- Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
- When set to C(auto) (the default) the precedence is module parameters -> C(env)
-> C(credential_file) -> C(cli).
- When set to C(env), the credentials will be read from the environment variables
- When set to C(credential_file), it will read the profile from C(~/.azure/credentials).
- When set to C(cli), the credentials will be sources from the Azure CLI profile.
C(subscription_id) or the environment variable C(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 C(msi), the host machine must be an azure resource with an enabled MSI
extension. C(subscription_id) or the environment variable C(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 C(msi) was added in Ansible 2.6.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
resource_group:
description:
- Name of the resource group containing the virtual machines (required when filtering
by vm name).
type: str
subscription_id:
description:
- Your Azure subscription Id.
type: str
cloud_environment:
default: AzureCloud
description:
- For cloud environments other than the US public cloud, the environment name (as
defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a
metadata discovery endpoint URL (required for Azure Stack). Can also be set via
credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
adfs_authority_url:
description:
- Azure AD authority url. Use when authenticating with Username/password, and has
your own ADFS authority.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
cert_validation_mode:
choices:
- ignore
- validate
description:
- 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
C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION)
environment variable.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
x509_certificate_path:
description:
- 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.
type: path
version_added: 1.14.0
version_added_collection: azure.azcollection
disable_instance_discovery:
default: false
description:
- 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 C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment
variable.
type: bool
version_added: 2.3.0
version_added_collection: azure.azcollection
vms:
contains:
additional_capabilities:
description:
- Enables or disables a capability on the virtual machine.
returned: always
sample:
ultra_ssd_enabled: false
type: dict
admin_username:
description:
- Administrator user name.
returned: always
sample: admin
type: str
boot_diagnostics:
contains:
console_screenshot_uri:
description:
- Contains a URI to grab a console screenshot.
- Only present if enabled.
returned: always
sample: https://mystorageaccountname.blob.core.windows.net/bootdiagnostics-myvm01-a4db09a6-ab7f-4d80-9da8-fbceaef9288a/
myVm.a4db09a6-ab7f-4d80-9da8-fbceaef9288a.screenshot.bmp
type: str
enabled:
description:
- Indicates if boot diagnostics are enabled.
returned: always
sample: true
type: bool
serial_console_log_uri:
description:
- Contains a URI to grab the serial console log.
- Only present if enabled.
returned: always
sample: https://mystorageaccountname.blob.core.windows.net/bootdiagnostics-myvm01-a4db09a6-ab7f-4d80-9da8-fbceaef9288a/
myVm.a4db09a6-ab7f-4d80-9da8-fbceaef9288a.serialconsole.log
type: str
storage_uri:
description:
- Indicates the storage account used by boot diagnostics.
returned: always
sample: https://mystorageaccountname.blob.core.windows.net/
type: str
description:
- Information about the boot diagnostics settings.
returned: always
type: complex
data_disks:
contains:
caching:
description:
- Type of data disk caching.
returned: always
sample: ReadOnly
type: str
disk_size_gb:
description:
- The initial disk size in GB for blank data disks.
returned: always
sample: 64
type: int
lun:
description:
- The logical unit number for data disk.
returned: always
sample: 0
type: int
managed_disk_id:
description:
- Managed data disk ID.
returned: always
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/Microsoft.Compute/disks/diskName
type: str
managed_disk_type:
description:
- Managed data disk type.
returned: always
sample: Standard_LRS
type: str
description:
- List of attached data disks.
returned: always
type: complex
display_status:
description:
- The short localizable label for the status.
returned: always
sample: VM running
type: str
id:
description:
- Resource ID.
returned: always
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVm
type: str
image:
contains:
id:
description:
- Custom image resource ID.
returned: when created from custom image
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage
type: str
offer:
description:
- The offer of the platform image or marketplace image used to create the
virtual machine.
returned: when created from marketplace image
sample: RHEL
type: str
publisher:
description:
- Publisher name.
returned: when created from marketplace image
sample: RedHat
type: str
sku:
description:
- SKU name.
returned: when created from marketplace image
sample: 7-RAW
type: str
version:
description:
- Image version.
returned: when created from marketplace image
sample: 7.5.2018050901
type: str
description:
- Image specification.
returned: always
type: complex
location:
description:
- Resource location.
returned: always
sample: japaneast
type: str
name:
description:
- Resource name.
returned: always
sample: myVm
type: str
network_interface_names:
description:
- List of attached network interfaces.
returned: always
sample:
- myNetworkInterface
type: list
os_disk_caching:
description:
- Type of OS disk caching.
returned: always
sample: ReadOnly
type: str
os_type:
description:
- Base type of operating system.
returned: always
sample: Linux
type: str
power_state:
description:
- Power state of the virtual machine.
returned: always
sample: running
type: str
provisioning_state:
description:
- The provisioning state, which only appears in the response.
returned: always
sample: running
type: str
proximityPlacementGroup:
description:
- The name or ID of the proximity placement group the VM should be associated
with.
returned: always
sample:
id: /subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.Compute/proximityPlacementGroups/testid13
type: dict
resource_group:
description:
- Resource group.
returned: always
sample: myResourceGroup
type: str
security_profile:
contains:
encryption_at_host:
description:
- 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: true
type: bool
security_type:
description:
- Specifies the SecurityType of the virtual machine.
- It is set as TrustedLaunch to enable UefiSettings.
returned: when-enabled
sample: TrustedLaunch
type: str
uefi_settings:
contains:
secure_boot_enabled:
description:
- Specifies whether secure boot should be enabled on the virtual machine.
returned: when-enabled
sample: true
type: bool
v_tpm_enabled:
description:
- Specifies whether vTPM should be enabled on the virtual machine.
returned: when-enabled
sample: true
type: bool
description:
- Specifies the security settings like secure boot and vTPM used while creating
the virtual machine.
returned: when-enabled
type: complex
description:
- Specifies the Security related profile settings for the virtual machine.
returned: when-used
type: complex
state:
description:
- State of the resource.
returned: always
sample: present
type: str
tags:
description:
- Resource tags.
returned: always
sample:
key1: value1
type: dict
vm_agent_version:
description:
- Version of the Azure VM Agent (waagent) running inside the VM.
returned: always
sample: 2.9.1.1
type: str
vm_size:
description:
- Virtual machine size.
returned: always
sample: Standard_D4
type: str
zones:
description:
- A list of Availability Zones for your VM.
sample:
- 1
type: list
description:
- List of virtual machines.
returned: always
type: complex