Note
This plugin is part of the azure.azcollection collection (version 1.10.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
.
To use it in a playbook, specify: azure.azcollection.azure_rm
.
ansible_host
to the first public IP address found (preferring the primary NIC). If no public IPs are found, the first private IP (also preferring the primary NIC). The default may be overridden via hostvar_expressions
; see examples.The below requirements are needed on the local controller node that executes this inventory.
Parameter | Choices/Defaults | Configuration | 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 |
| 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 variablesWhen 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. | |
batch_fetch string | Default: "yes" | To improve performance, results are fetched using an unsupported batch API. Disabling batch_fetch uses a much slower serial fetch, resulting in many more round-trips. Generally only useful for troubleshooting. | |
cert_validation_mode string added in 0.0.1 of azure.azcollection |
| 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. | |
compose dictionary | Default: {} | Create vars from jinja2 expressions. | |
conditional_groups string | A mapping of group names to Jinja2 expressions. When the mapped expression is true, the host is added to the named group. | ||
default_host_filters string | Default: ["powerstate != \"running\"", "provisioning_state != \"succeeded\""] | A default set of filters that is applied in addition to the conditions in exclude_host_filters to exclude powered-off and not-fully-provisioned hosts. Set this to a different value or empty list if you need to include hosts in these states. | |
exclude_host_filters string | Default: [] | Excludes hosts from the inventory with a list of Jinja2 conditional expressions. Each expression in the list is evaluated for each host; when the expression is true, the host is excluded from the inventory. | |
fail_on_template_errors string |
"yes" | When false, template failures during group and filter processing are silently ignored (eg, if a filter or group expression refers to an undefined host variable) | |
groups dictionary | Default: {} | Add hosts to group based on Jinja2 conditionals. | |
hostnames list / elements=string | Default: ["default"] | A list of Jinja2 expressions in order of precedence to compose inventory_hostname. Ignores expression if result is an empty string or None value. By default, inventory_hostname is generated to be globally unique based on the VM host name. See plain_host_names for more details on the default.An expression of 'default' will force using the default hostname generator if no previous hostname expression resulted in a valid hostname. Use ``default_inventory_hostname`` to access the default hostname generator's value in any of the Jinja2 expressions. | |
hostvar_expressions string | A mapping of hostvar names to Jinja2 expressions. The value for each host is the result of the Jinja2 expression (which may refer to any of the host's existing variables at the time this inventory plugin runs). | ||
include_vm_resource_groups string | Default: ["*"] | A list of resource group names to search for virtual machines. '\*' will include all resource groups in the subscription. | |
include_vmss_resource_groups string | Default: [] | A list of resource group names to search for virtual machine scale sets (VMSSs). '\*' will include all resource groups in the subscription. | |
keyed_groups list / elements=string | Default: [] | Creates groups based on the value of a host variable. Requires a list of dictionaries, defining key (the source dictionary-typed variable), prefix (the prefix to use for the new group name), and optionally separator (which defaults to _ ) | |
leading_separator boolean added in 2.11 of ansible.builtin |
| Use in conjunction with keyed_groups. By default, a keyed group that does not have a prefix or a separator provided will have a name that starts with an underscore. This is because the default prefix is "" and the default separator is "_". Set this option to False to omit the leading underscore (or other separator) if no prefix is given. If the group name is derived from a mapping the separator is still used to concatenate the items. To not use a separator in the group name at all, set the separator for the keyed group to an empty string instead. | |
log_mode string | Parent argument. | ||
log_path string | Parent argument. | ||
password string | Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | ||
plain_host_names boolean added in 2.8 of azure.azcollection |
| By default this plugin will use globally unique host names. This option allows you to override that, and use the name that matches the old inventory script naming. This is not the default, as these names are not truly unique, and can conflict with other hosts. The default behavior will add extra hashing to the end of the hostname to prevent such conflicts. | |
plugin string / required |
| marks this as an instance of the 'azure_rm' plugin | |
profile string | Security profile found in ~/.azure/credentials file. | ||
secret string | Azure client secret. Use when authenticating with a Service Principal. | ||
strict boolean |
| If yes make invalid entries a fatal error, otherwise skip and continue.Since it is possible to use facts in the expressions they might not always be available and we ignore those errors by default. | |
subscription_id string | Your Azure subscription Id. | ||
tenant string | Azure tenant ID. Use when authenticating with a Service Principal. | ||
use_contrib_script_compatible_sanitization boolean added in 2.8 of azure.azcollection |
| By default this plugin is using a general group name sanitization to create safe and usable group names for use in Ansible. This option allows you to override that, in efforts to allow migration from the old inventory script and matches the sanitization of groups when the script's ``replace_dash_in_groups`` option is set to ``False``. To replicate behavior of ``replace_dash_in_groups = True`` with constructed groups, you will need to replace hyphens with underscores via the regex_replace filter for those entries. For this to work you should also turn off the TRANSFORM_INVALID_GROUP_CHARS setting, otherwise the core engine will just use the standard sanitization on top. This is not the default as such names break certain functionality as not all characters are valid Python identifiers which group names end up being used as. | |
use_extra_vars boolean added in 2.11 of ansible.builtin |
| ini entries: [inventory_plugins] env:ANSIBLE_INVENTORY_USE_EXTRA_VARS | Merge extra vars into the available variables for composition (highest precedence). |
Note
az login
.See also
How to authenticate using the az login
command.
# The following host variables are always available: # public_ipv4_addresses: all public IP addresses, with the primary IP config from the primary NIC first # public_dns_hostnames: all public DNS hostnames, with the primary IP config from the primary NIC first # private_ipv4_addresses: all private IP addressses, with the primary IP config from the primary NIC first # id: the VM's Azure resource ID, eg /subscriptions/00000000-0000-0000-1111-1111aaaabb/resourceGroups/my_rg/providers/Microsoft.Compute/virtualMachines/my_vm # location: the VM's Azure location, eg 'westus', 'eastus' # name: the VM's resource name, eg 'myvm' # os_profile: The VM OS properties, a dictionary, only system is currently available, eg 'os_profile.system not in ['linux']' # powerstate: the VM's current power state, eg: 'running', 'stopped', 'deallocated' # provisioning_state: the VM's current provisioning state, eg: 'succeeded' # tags: dictionary of the VM's defined tag values # resource_type: the VM's resource type, eg: 'Microsoft.Compute/virtualMachine', 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines' # vmid: the VM's internal SMBIOS ID, eg: '36bca69d-c365-4584-8c06-a62f4a1dc5d2' # vmss: if the VM is a member of a scaleset (vmss), a dictionary including the id and name of the parent scaleset # availability_zone: availability zone in which VM is deployed, eg '1','2','3' # # The following host variables are sometimes availble: # computer_name: the Operating System's hostname. Will not be available if azure agent is not available and picking it up. # sample 'myazuresub.azure_rm.yaml' # required for all azure_rm inventory plugin configs plugin: azure.azcollection.azure_rm # forces this plugin to use a CLI auth session instead of the automatic auth source selection (eg, prevents the # presence of 'ANSIBLE_AZURE_RM_X' environment variables from overriding CLI auth) auth_source: cli # fetches VMs from an explicit list of resource groups instead of default all (- '*') include_vm_resource_groups: - myrg1 - myrg2 # fetches VMs from VMSSs in all resource groups (defaults to no VMSS fetch) include_vmss_resource_groups: - '*' # places a host in the named group if the associated condition evaluates to true conditional_groups: # since this will be true for every host, every host sourced from this inventory plugin config will be in the # group 'all_the_hosts' all_the_hosts: true # if the VM's "name" variable contains "dbserver", it will be placed in the 'db_hosts' group db_hosts: "'dbserver' in name" # adds variables to each host found by this inventory plugin, whose values are the result of the associated expression hostvar_expressions: my_host_var: # A statically-valued expression has to be both single and double-quoted, or use escaped quotes, since the outer # layer of quotes will be consumed by YAML. Without the second set of quotes, it interprets 'staticvalue' as a # variable instead of a string literal. some_statically_valued_var: "'staticvalue'" # overrides the default ansible_host value with a custom Jinja2 expression, in this case, the first DNS hostname, or # if none are found, the first public IP address. ansible_host: (public_dns_hostnames + public_ipv4_addresses) | first # change how inventory_hostname is generated. Each item is a jinja2 expression similar to hostvar_expressions. hostnames: - tags.vm_name - default # special var that uses the default hashed name # places hosts in dynamically-created groups based on a variable value. keyed_groups: # places each host in a group named 'tag_(tag name)_(tag value)' for each tag on a VM. - prefix: tag key: tags # places each host in a group named 'azure_loc_(location name)', depending on the VM's location - prefix: azure_loc key: location # places host in a group named 'some_tag_X' using the value of the 'sometag' tag on a VM as X, and defaulting to the # value 'none' (eg, the group 'some_tag_none') if the 'sometag' tag is not defined for a VM. - prefix: some_tag key: tags.sometag | default('none') # excludes a host from the inventory when any of these expressions is true, can refer to any vars defined on the host exclude_host_filters: # excludes hosts in the eastus region - location in ['eastus'] # excludes hosts that are powered off - powerstate != 'running'
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_inventory.html