community.azure.azure_rm_networkinterface_info – Get network interface facts

From Get docs
Ansible/docs/2.10/collections/community/azure/azure rm networkinterface info module


community.azure.azure_rm_networkinterface_info – Get network interface facts

Note

This plugin is part of the community.azure collection (version 1.0.0).

To install it use: ansible-galaxy collection install community.azure.

To use it in a playbook, specify: community.azure.azure_rm_networkinterface_info.


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

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

  • auto

  • cli
  • credential_file
  • env
  • msi

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 variables

When 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.

cert_validation_mode

string

added in 0.0.1 of azure.azcollection

  • ignore
  • validate

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.

name

string

Only show results for a specific network interface.

password

string

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

profile

string

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

resource_group

string

Name of the resource group containing the network interface(s). Required when searching by name.

secret

string

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

subscription_id

string

Your Azure subscription Id.

tags

string

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

tenant

string

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



Notes

Note

  • For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with az login.
  • Authentication is also 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.


See Also

See also

Sign in with Azure CLI
How to authenticate using the az login command.


Examples

- name: Get facts for one network interface
  community.azure.azure_rm_networkinterface_info:
    resource_group: myResourceGroup
    name: nic001

- name: Get network interfaces within a resource group
  community.azure.azure_rm_networkinterface_info:
    resource_group: myResourceGroup

- name: Get network interfaces by tag
  community.azure.azure_rm_networkinterface_info:
    resource_group: myResourceGroup
    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 / elements=string

always

List of network interface dicts.


Sample:

[{'dns_settings': {'applied_dns_servers': [], 'dns_servers': [], 'internal_dns_name_label': None, 'internal_fqdn': None}, 'enable_ip_forwarding': False, 'etag': 'W/"59726bfc-08c4-44ed-b900-f6a559876a9d"', 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nic003', 'ip_configuration': {'name': 'default', 'private_ip_address': '10.10.0.4', 'private_ip_allocation_method': 'Dynamic', 'public_ip_address': {'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/publicip001', 'name': 'publicip001'}, 'subnet': {'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet001/subnets/subnet001', 'name': 'subnet001', 'virtual_network_name': 'vnet001'}}, 'location': 'westus', 'mac_address': None, 'name': 'nic003', 'network_security_group': {'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/secgroup001', 'name': 'secgroup001'}, 'primary': None, 'provisioning_state': 'Succeeded', 'tags': {}, 'type': 'Microsoft.Network/networkInterfaces'}]

networkinterfaces

list / elements=string

always

List of network interface dicts. Each dict contains parameters can be passed to community.azure.azure_rm_networkinterface module.


create_with_security_group

boolean

success

Specifies whether a default security group should be be created with the NIC. Only applies when creating a new NIC.


dns_servers

string

success

Which DNS servers should the NIC lookup.

List of IP addresses.


dns_settings

string

success

The DNS settings in network interface.


applied_dns_servers

string

success

If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs.


dns_servers

string

success

List of DNS servers IP addresses.


internal_dns_name_label

string

success

Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.


internal_fqdn

string

success

Fully qualified DNS name supporting internal communications between VMs in the same virtual network.


enable_accelerated_networking

string

success

Specifies whether the network interface should be created with the accelerated networking feature or not.


enable_ip_forwarding

string

success

Whether to enable IP forwarding


id

string

success

Id of the network interface.


ip_configurations

string

success

List of IP configurations, if contains multiple configurations.


application_security_groups

string

success

List of Application security groups.


Sample:

/subscriptions//resourceGroups//providers/Microsoft.Network/applicationSecurityGroups/myASG

load_balancer_backend_address_pools

string

success

List of existing load-balancer backend address pools to associate with the network interface.


name

string

success

Name of the IP configuration.


primary

string

success

Whether the IP configuration is the primary one in the list.


private_ip_address

string

success

Private IP address for the IP configuration.


private_ip_allocation_method

string

success

Private IP allocation method.


public_ip_address

string

success

Name of the public IP address. None for disable IP address.


public_ip_allocation_method

string

success

Public IP allocation method.


location

string

success

Azure location.


mac_address

string

success

The MAC address of the network interface.


name

string

success

Name of the network interface.


provisioning_state

string

success

The provisioning state of the network interface.


resource_group

string

success

Name of a resource group where the network interface exists.


security_group

string

success

A security group resource ID with which to associate the network interface.


subnet

string

success

Name of an existing subnet within the specified virtual network.


tags

string

success

Tags of the network interface.


virtual_network

string

success

An existing virtual network with which the network interface will be associated.

It is a dict which contains name and resource_group of the virtual network.





Authors

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/azure/azure_rm_networkinterface_info_module.html