W3cubDocs

/Ansible

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 (on host that executes module)

  • python >= 2.7
  • azure == 2.0.0rc5

Options

parameter required default choices comments
ad_user
 no
Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
client_id
 no
Azure client ID. Use when authenticating with a Service Principal.
name
 no
Only show results for a specific network interface.
password
 no
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile
 no
Security profile found in ~/.azure/credentials file.
resource_group
 no
Name of the resource group containing the network interface(s). Required when searching by name.
secret
 no
Azure client secret. Use when authenticating with a Service Principal.
subscription_id
 no
Your Azure subscription Id.
tags
 no
Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
tenant
 no
Azure tenant ID. Use when authenticating with a Service Principal.

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 Common Return Values, the following are the fields unique to this module:

name description returned type sample
azure_networkinterfaces List of network interface dicts. always list

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 set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.

Note

To Authentication via Active Directory user pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.

Note

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.

This is a Core Module

For more information on what this means please read Core Modules

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/azure_rm_networkinterface_facts_module.html