Try SpotterGet network interface facts
Authors: Chris Houseknecht (@chouseknecht), Matt Davis (@nitzmahone)
preview | supported by community
Install with ansible-galaxy collection install community.azure:==0.1.0
collections:
- name: community.azure
version: 0.1.0Get facts for a specific network interface or all network interfaces within a resource group.
- name: Get facts for one network interface
azure_rm_networkinterface_info:
resource_group: myResourceGroup
name: nic001
- name: Get network interfaces within a resource group
azure_rm_networkinterface_info:
resource_group: myResourceGroup
- name: Get network interfaces by tag
azure_rm_networkinterface_info:
resource_group: myResourceGroup
tags:
- testing
- foo:bar
name:
description:
- Only show results for a specific network interface.
tags:
description:
- Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
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
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.
type: str
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: '2.5'
version_added_collection: azure.azcollection
auth_source:
choices:
- auto
- cli
- credential_file
- env
- msi
description:
- Controls the source of the credentials to use for authentication.
- If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and
default to C(auto) if variable is not defined.
- C(auto) will follow the default precedence of module parameters -> environment variables
-> default profile in credential file C(~/.azure/credentials).
- When set to C(cli), the credentials will be sources from the default Azure CLI profile.
- Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
- 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: '2.5'
version_added_collection: azure.azcollection
resource_group:
description:
- Name of the resource group containing the network interface(s). Required when searching
by name.
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: '2.4'
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: '2.6'
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: '2.5'
version_added_collection: azure.azcollection
azure_networkinterfaces:
description:
- List of network interface dicts.
example:
- dns_settings:
applied_dns_servers: []
dns_servers: []
internal_dns_name_label: null
internal_fqdn: null
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: null
name: nic003
network_security_group:
id: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/secgroup001
name: secgroup001
primary: null
provisioning_state: Succeeded
tags: {}
type: Microsoft.Network/networkInterfaces
returned: always
type: list
networkinterfaces:
contains:
create_with_security_group:
description:
- Specifies whether a default security group should be be created with the NIC.
Only applies when creating a new NIC.
type: bool
dns_servers:
description:
- Which DNS servers should the NIC lookup.
- List of IP addresses.
dns_settings:
contains:
applied_dns_servers:
description:
- 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:
description:
- List of DNS servers IP addresses.
internal_dns_name_label:
description:
- Relative DNS name for this NIC used for internal communications between
VMs in the same virtual network.
internal_fqdn:
description:
- Fully qualified DNS name supporting internal communications between VMs
in the same virtual network.
description:
- The DNS settings in network interface.
enable_accelerated_networking:
description:
- Specifies whether the network interface should be created with the accelerated
networking feature or not.
enable_ip_forwarding:
description:
- Whether to enable IP forwarding
id:
description:
- Id of the network interface.
ip_configurations:
contains:
application_security_groups:
description:
- List of Application security groups.
sample: /subscriptions/<subsid>/resourceGroups/<rg>/providers/Microsoft.Network/applicationSecurityGroups/myASG
load_balancer_backend_address_pools:
description:
- List of existing load-balancer backend address pools to associate with
the network interface.
name:
description:
- Name of the IP configuration.
primary:
description:
- Whether the IP configuration is the primary one in the list.
private_ip_address:
description:
- Private IP address for the IP configuration.
private_ip_allocation_method:
description:
- Private IP allocation method.
public_ip_address:
description:
- Name of the public IP address. None for disable IP address.
public_ip_allocation_method:
description:
- Public IP allocation method.
description:
- List of IP configurations, if contains multiple configurations.
location:
description:
- Azure location.
mac_address:
description:
- The MAC address of the network interface.
name:
description:
- Name of the network interface.
provisioning_state:
description:
- The provisioning state of the network interface.
resource_group:
description:
- Name of a resource group where the network interface exists.
security_group:
description:
- A security group resource ID with which to associate the network interface.
subnet:
description:
- Name of an existing subnet within the specified virtual network.
tags:
description:
- Tags of the network interface.
virtual_network:
description:
- An existing virtual network with which the network interface will be associated.
- It is a dict which contains I(name) and I(resource_group) of the virtual network.
description:
- List of network interface dicts. Each dict contains parameters can be passed to
M(azure_rm_networkinterface) module.
returned: always
type: list