azure.azcollection.azure_rm_vmssnetworkinterface_info 模块 – 获取虚拟机规模集中的网络接口信息

注意

此模块是 azure.azcollection 集合 (版本 3.1.0) 的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install azure.azcollection。您需要其他要求才能使用此模块，有关详细信息，请参见 要求。

要在 playbook 中使用它，请指定： azure.azcollection.azure_rm_vmssnetworkinterface_info。

azure.azcollection 1.15.0 中的新增功能

概要

  • 获取虚拟机规模集中的网络接口信息。

要求

执行此模块的主机需要以下要求。

  • python >= 2.7

  • 执行此模块的主机必须通过 galaxy 安装 azure.azcollection 集合

  • 集合的 requirements.txt 中列出的所有 python 包都必须通过 pip 安装在执行 azure.azcollection 集合中模块的主机上

  • 完整的安装说明可在 https://galaxy.ansible.com/azure/azcollection 找到

参数

参数

注释

ad_user

字符串

活动目录用户名。使用时通过活动目录用户而不是服务主体进行身份验证。

adfs_authority_url

字符串

在 azure.azcollection 0.0.1 中添加

Azure AD 授权 URL。当使用用户名/密码进行身份验证并且拥有自己的 ADFS 授权时使用。

api_profile

字符串

在 azure.azcollection 0.0.1 中添加

选择与 Azure 服务通信时要使用的 API 配置文件。 latest 的默认值适用于公共云；未来的值将允许与 Azure Stack 一起使用。

默认值： "latest"

auth_source

字符串

在 azure.azcollection 0.0.1 中添加

控制用于身份验证的凭据来源。

也可以通过 ANSIBLE_AZURE_AUTH_SOURCE 环境变量设置。

设置为 auto（默认值）时，优先级为模块参数 -> env -> credential_file -> cli。

设置为 env 时，凭据将从环境变量中读取。

设置为 credential_file 时，它将从 ~/.azure/credentials 读取配置文件。

设置为 cli 时，凭据将从 Azure CLI 配置文件获取。如果存在多个订阅，则可以使用 subscription_id 或环境变量 AZURE_SUBSCRIPTION_ID 来标识订阅 ID，否则使用默认的 az cli 订阅。

设置为 msi 时，主机必须是启用了 MSI 扩展的 Azure 资源。如果资源被授予对多个订阅的访问权限，则可以使用 subscription_id 或环境变量 AZURE_SUBSCRIPTION_ID 来标识订阅 ID，否则选择第一个订阅。

Ansible 2.6 中添加了 msi。

选项

  • "auto" ← (默认值)

  • "cli"

  • "credential_file"

  • "env"

  • "msi"

cert_validation_mode

字符串

在 azure.azcollection 0.0.1 中添加

控制 Azure 端点的证书验证行为。默认情况下，所有模块都将验证服务器证书，但是当使用 HTTPS 代理或针对 Azure Stack 时，可能需要通过传递 ignore 来禁用此行为。也可以通过凭据文件配置文件或 AZURE_CERT_VALIDATION 环境变量设置。

选项

  • "ignore"

  • "validate"

client_id

字符串

Azure 客户端 ID。使用服务主体或托管标识 (msi) 进行身份验证时使用。

也可以通过 AZURE_CLIENT_ID 环境变量设置。

cloud_environment

字符串

在 azure.azcollection 0.0.1 中添加

对于美国公共云以外的云环境，环境名称（由 Azure Python SDK 定义，例如 AzureChinaCloud、AzureUSGovernment）或元数据发现端点 URL（Azure Stack 需要）。也可以通过凭据文件配置文件或 AZURE_CLOUD_ENVIRONMENT 环境变量设置。

默认值： "AzureCloud"

disable_instance_discovery

布尔值

在 azure.azcollection 2.3.0 中添加

确定在尝试身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和权限验证。此功能旨在用于无法访问元数据端点的场景，例如私有云或 Azure Stack。实例发现过程需要从https://login.microsoft.com/检索权限元数据以验证权限。将其设置为**True**将禁用权限验证。因此，务必确保配置的权限主机有效且值得信赖。

通过凭据文件配置文件或AZURE_DISABLE_INSTANCE_DISCOVERY环境变量设置。

选项

  • false ← (默认)

  • true

log_mode

字符串

父参数。

log_path

字符串

父参数。

name

字符串

网络接口的名称。

如果配置name，则必须设置参数vm_index。

password

字符串

Active Directory 用户密码。在使用 Active Directory 用户而不是服务主体进行身份验证时使用。

profile

字符串

在 ~/.azure/credentials 文件中找到的安全配置文件。

resource_group

字符串 / 必需

资源组的名称。

secret

字符串

Azure 客户端密钥。在使用服务主体进行身份验证时使用。

subscription_id

字符串

您的 Azure 订阅 ID。

tenant

字符串

Azure 租户 ID。在使用服务主体进行身份验证时使用。

thumbprint

字符串

在 azure.azcollection 1.14.0 中添加

在x509_certificate_path中指定的私钥的指纹。

在使用服务主体进行身份验证时使用。

如果定义了x509_certificate_path，则为必需。

vm_index

字符串

虚拟机索引，例如vm_index=0。

vmss_name

字符串 / 必需

虚拟机规模集的名称。

x509_certificate_path

路径

在 azure.azcollection 1.14.0 中添加

PEM 格式下用于创建服务主体的 X509 证书的路径。

证书必须附加到私钥。

在使用服务主体进行身份验证时使用。

注释

注意

  • 对于 Azure 身份验证，您可以传递参数、设置环境变量、使用存储在 ~/.azure/credentials 中的配置文件，或者在运行任务或剧本之前使用az login登录。

  • 也可以使用服务主体或 Active Directory 用户进行身份验证。

  • 要通过服务主体进行身份验证，请传递 subscription_id、client_id、secret 和 tenant，或设置环境变量 AZURE_SUBSCRIPTION_ID、AZURE_CLIENT_ID、AZURE_SECRET 和 AZURE_TENANT。

  • 要通过 Active Directory 用户进行身份验证，请传递 ad_user 和 password，或在环境中设置 AZURE_AD_USER 和 AZURE_PASSWORD。

  • 或者，凭据可以存储在 ~/.azure/credentials 中。这是一个包含 [default] 部分和以下密钥的 ini 文件：subscription_id、client_id、secret 和 tenant 或 subscription_id、ad_user 和 password。也可以添加其他配置文件。通过传递 profile 或在环境中设置 AZURE_PROFILE 来指定配置文件。

另请参阅

另请参阅

使用 Azure CLI 登录

如何使用az login命令进行身份验证。

示例

- 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

返回值

常见的返回值已在此处记录，以下是此模块特有的字段

键

描述

vmss_networkinterfaces

复杂类型

网络接口字典列表。每个字典都包含可以传递给azure.azcollection.azure_rm_vmssnetworkinterface 模块的参数。

返回：始终

create_with_security_group

布尔值

指定是否应使用 NIC 创建默认安全组。仅适用于创建新的 NIC 时。

返回：始终

示例：true

dns_servers

列表 / 元素=字符串

NIC 应该查找哪些 DNS 服务器。

IP 地址列表。

返回：始终

示例：[]

dns_settings

复杂类型

网络接口中的 DNS 设置。

返回：始终

applied_dns_servers

列表 / 元素=字符串

如果使用此 NIC 的虚拟机是可用性集中的一部分，则此列表将包含属于可用性集的所有 NIC 的所有 DNS 服务器的并集。此属性是在这些虚拟机上配置的内容。

返回：始终

示例：[]

dns_servers

列表 / 元素=字符串

DNS 服务器 IP 地址列表。

返回：始终

示例：[]

internal_dns_name_label

字符串

此 NIC 用于同一虚拟网络中虚拟机之间内部通信的相对 DNS 名称。

返回：始终

internal_fqdn

字符串

支持同一虚拟网络中虚拟机之间内部通信的完全限定 DNS 名称。

返回：始终

enable_accelerated_networking

布尔值

指定是否应使用加速网络功能创建网络接口。

返回：始终

示例：true

enable_ip_forwarding

布尔值

是否启用 IP 转发

返回：始终

示例：true

id

字符串

网络接口的 ID。

返回：始终

示例："/subscriptions/xxx-xxx/resourceGroups/RG/providers/Microsoft.Compute/virtualMachineScaleSets/fredvmss/virtualMachines/1/networkInterfaces/nic01"

ip_configurations

复杂类型

IP 配置列表，如果包含多个配置。

返回：始终

application_gateway_backend_address_pools

字符串

与网络接口关联的现有应用程序网关后端地址池列表。

返回：始终

application_security_groups

字符串

应用程序安全组列表。

返回：始终

示例："/subscriptions/<subsid>/resourceGroups/<rg>/providers/Microsoft.Network/applicationSecurityGroups/myASG"

load_balancer_backend_address_pools

字符串

与网络接口关联的现有负载均衡器后端地址池列表。

返回：始终

name

字符串

IP 配置的名称。

返回：始终

示例："defaultIpConfiguration"

primary

布尔值

IP 配置是否为列表中的主要配置。

返回：始终

示例：true

private_ip_address

字符串

IP 配置的私有 IP 地址。

返回：始终

示例："10.3.0.5"

private_ip_allocation_method

字符串

私有 IP 分配方法。

返回：始终

示例："Dynamic"

public_ip_address

字符串

公有 IP 地址的名称。禁用 IP 地址时为 None。

返回：始终

public_ip_allocation_method

字符串

公有 IP 分配方法。

返回：始终

location

字符串

Azure 位置。

返回：始终

示例："eastus"

mac_address

字符串

网络接口的 MAC 地址。

返回：始终

示例："00-0D-3A-17-EC-36"

name

字符串

网络接口的名称。

返回：始终

示例："nic01"

provisioning_state

字符串

网络接口的预配状态。

返回：始终

示例："Succeeded"

resource_group

字符串

存在网络接口的资源组的名称。

返回：始终

示例："RG"

security_group

字符串

要与网络接口关联的安全组资源 ID。

返回：始终

示例："/subscriptions/xxx-xxx/resourceGroups/RG/providers/Microsoft.Network/networkSecurityGroups/nic01"

subnet

字符串

指定虚拟网络中现有子网的名称。

返回：始终

示例："default"

tags

字典

网络接口的标签。

返回：始终

示例：{"key1": "value1"}

virtual_network

字典

将与网络接口关联的现有虚拟网络。

它是一个字典，包含虚拟网络的name和resource_group。

返回：始终

示例：{"name": "vnet01", "resource_group": "RG"}

作者

  • xuzhang3 (@xuzhang3)

  • Fred-sun (@Fred-sun)