Documentation

azure_rm_networkinterface_facts - Get network interface facts.

New in version 2.1.

Synopsis

  • Get facts for a specific network interface or all network interfaces within 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
Default:
None
Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
api_profile
(added in 2.5)
    Choices:
  • 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)
    Choices:
  • auto ←
  • cli
  • credential_file
  • env
Controls the source of the credentials to use for authentication.
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.
cert_validation_mode
(added in 2.5)
    Choices:
  • validate
  • ignore
Default:
None
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
Default:
None
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
Default:
None
Only show results for a specific network interface.
password
Default:
None
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile
Default:
None
Security profile found in ~/.azure/credentials file.
resource_group
Default:
None
Name of the resource group containing the network interface(s). Required when searching by name.
secret
Default:
None
Azure client secret. Use when authenticating with a Service Principal.
subscription_id
Default:
None
Your Azure subscription Id.
tags
Default:
None
Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
tenant
Default:
None
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 one network interface
  azure_rm_networkinterface_facts:
    resource_group: Testing
    name: nic001

- name: Get network interfaces within a resource group
  azure_rm_networkinterface_facts:
    resource_group: Testing

- name: Get network interfaces by tag
  azure_rm_networkinterface_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
azure_networkinterfaces
list
always
List of network interface dicts.


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Chris Houseknecht (@chouseknecht)
  • Matt Davis (@nitzmahone)

Hint

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