azure / azure.azcollection / 2.3.0 / module / azure_rm_vmssnetworkinterface_info Get information about network interface in virtul machine scale | "added in version" 1.15.0 of azure.azcollection" Authors: xuzhang3 (@xuzhang3), Fred-sun (@Fred-sun)azure.azcollection.azure_rm_vmssnetworkinterface_info (2.3.0) — module
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections: - name: azure.azcollection version: 2.3.0
Get information about network interface in virtual machine scale set.
- name: Get information by the network name azure_rm_vmssnetworkinterface_info: resource_group: myResourceGroup name: nic001 vmss_name: testVMSS vm_index: 0
- name: Get all network interface information in virtual machine scale set azure_rm_vmssnetworkinterface_info: resource_group: myResourceGroup vmss_name: testVMSS
- name: Get all network interface information in the same virtual machine index. azure_rm_vmssnetworkinterface_info: resource_group: myResourceGroup vmss_name: testVMSS vm_index: 1
name: description: - The name of the network interface. - If configure I(name), you must set the parameters I(vm_index). type: str 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 log_mode: description: - Parent argument. type: str log_path: description: - Parent argument. type: str password: description: - Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. type: str vm_index: description: - The virtual machine index, such as I(vm_index=0). type: str client_id: description: - Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi). - Can also be set via the C(AZURE_CLIENT_ID) environment variable. type: str vmss_name: description: - The name of the virtual machine scale set. required: true type: str thumbprint: description: - The thumbprint of the private key specified in I(x509_certificate_path). - Use when authenticating with a Service Principal. - Required if I(x509_certificate_path) is defined. type: str version_added: 1.14.0 version_added_collection: azure.azcollection 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: 0.0.1 version_added_collection: azure.azcollection auth_source: choices: - auto - cli - credential_file - env - msi default: auto description: - Controls the source of the credentials to use for authentication. - Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. - When set to C(auto) (the default) the precedence is module parameters -> C(env) -> C(credential_file) -> C(cli). - When set to C(env), the credentials will be read from the environment variables - When set to C(credential_file), it will read the profile from C(~/.azure/credentials). - When set to C(cli), the credentials will be sources from the Azure CLI profile. C(subscription_id) or the environment variable C(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 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: 0.0.1 version_added_collection: azure.azcollection resource_group: description: - Name of the resource group. required: true type: str 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: 0.0.1 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: 0.0.1 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: 0.0.1 version_added_collection: azure.azcollection x509_certificate_path: description: - Path to the X509 certificate used to create the service principal in PEM format. - The certificate must be appended to the private key. - Use when authenticating with a Service Principal. type: path version_added: 1.14.0 version_added_collection: azure.azcollection disable_instance_discovery: default: false description: - Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to **True**, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy. - Set via credential file profile or the C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment variable. type: bool version_added: 2.3.0 version_added_collection: azure.azcollection
vmss_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. returned: always sample: true type: bool dns_servers: description: - Which DNS servers should the NIC lookup. - List of IP addresses. returned: always sample: [] type: list 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. returned: always sample: [] type: list dns_servers: description: - List of DNS servers IP addresses. returned: always sample: [] type: list internal_dns_name_label: description: - Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. returned: always sample: null type: str internal_fqdn: description: - Fully qualified DNS name supporting internal communications between VMs in the same virtual network. returned: always sample: null type: str description: - The DNS settings in network interface. returned: always type: complex enable_accelerated_networking: description: - Specifies whether the network interface should be created with the accelerated networking feature or not. returned: always sample: true type: bool enable_ip_forwarding: description: - Whether to enable IP forwarding returned: always sample: true type: bool id: description: - Id of the network interface. returned: always sample: /subscriptions/xxx-xxx/resourceGroups/RG/providers/Microsoft.Compute/virtualMachineScaleSets/fredvmss/virtualMachines/1/networkInterfaces/nic01 type: str ip_configurations: contains: application_gateway_backend_address_pools: description: - List of existing application gateway backend address pools associated with the network interface. returned: always sample: null type: str application_security_groups: description: - List of Application security groups. returned: always sample: /subscriptions/<subsid>/resourceGroups/<rg>/providers/Microsoft.Network/applicationSecurityGroups/myASG type: str load_balancer_backend_address_pools: description: - List of existing load-balancer backend address pools associated with the network interface. returned: always sample: null type: str name: description: - Name of the IP configuration. returned: always sample: defaultIpConfiguration type: str primary: description: - Whether the IP configuration is the primary one in the list. returned: always sample: true type: bool private_ip_address: description: - Private IP address for the IP configuration. returned: always sample: 10.3.0.5 type: str private_ip_allocation_method: description: - Private IP allocation method. returned: always sample: Dynamic type: str public_ip_address: description: - Name of the public IP address. None for disable IP address. returned: always sample: null type: str public_ip_allocation_method: description: - Public IP allocation method. returned: always sample: null type: str description: - List of IP configurations, if contains multiple configurations. returned: always type: complex location: description: - Azure location. returned: always sample: eastus type: str mac_address: description: - The MAC address of the network interface. returned: always sample: 00-0D-3A-17-EC-36 type: str name: description: - Name of the network interface. returned: always sample: nic01 type: str provisioning_state: description: - The provisioning state of the network interface. returned: always sample: Succeeded type: str resource_group: description: - Name of a resource group where the network interface exists. returned: always sample: RG type: str security_group: description: - A security group resource ID with which to associate the network interface. returned: always sample: /subscriptions/xxx-xxx/resourceGroups/RG/providers/Microsoft.Network/networkSecurityGroups/nic01 type: str subnet: description: - Name of an existing subnet within the specified virtual network. returned: always sample: default type: str tags: description: - Tags of the network interface. returned: always sample: key1: value1 type: dict 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. returned: always sample: name: vnet01 resource_group: RG type: dict description: - List of network interface dicts. Each dict contains parameters can be passed to M(azure.azcollection.azure_rm_vmssnetworkinterface) module. returned: always type: complex