azure_rm_networkinterface - Manage Azure network interfaces.

• Synopsis
  • Requirements
• Parameters
• Notes
• Examples
• Return Values
• Status
  • Author

Synopsis

• Create, update or delete a network interface. When creating a network interface you must provide the name of an existing virtual network, the name of an existing subnet within the virtual network. A default security group and public IP address will be created automatically, or you can provide the name of an existing security group and public IP address. See the examples below for more details.

Requirements

The below requirements are needed on the host that executes this module.

• python >= 2.7
• azure >= 2.0.0

Parameters

Notes

Examples

- name: Create a network interface with minimal parameters
  azure_rm_networkinterface:
    name: nic001
    resource_group: Testing
    virtual_network_name: vnet001
    subnet_name: subnet001
    ip_configurations:
      - name: ipconfig1
        public_ip_address_name: publicip001
        primary: True

- name: Create a network interface with private IP address only (no Public IP)
  azure_rm_networkinterface:
    name: nic001
    resource_group: Testing
    virtual_network_name: vnet001
    subnet_name: subnet001
    ip_configurations:
      - name: ipconfig1
        primary: True

- name: Create a network interface for use in a Windows host (opens RDP port) with custom RDP port
  azure_rm_networkinterface:
    name: nic002
    resource_group: Testing
    virtual_network_name: vnet001
    subnet_name: subnet001
    os_type: Windows
    rdp_port: 3399
    ip_configurations:
      - name: ipconfig1
        public_ip_address_name: publicip001
        primary: True

- name: Create a network interface using existing security group and public IP
  azure_rm_networkinterface:
    name: nic003
    resource_group: Testing
    virtual_network_name: vnet001
    subnet_name: subnet001
    security_group_name: secgroup001
    ip_configurations:
      - name: ipconfig1
        public_ip_address_name: publicip001
        primary: True

- name: Create a network with mutilple ip configurations
  azure_rm_networkinterface:
    name: nic004
    resource_group: Testing
    subnet_name: subnet001
    virtual_network_name: vnet001
    security_group_name: secgroup001
    ip_configurations:
      - name: ipconfig1
        public_ip_address_name: publicip001
        primary: True
      - name: ipconfig2

- name: Delete network interface
  azure_rm_networkinterface:
    resource_group: Testing
    name: nic003
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

• Chris Houseknecht (@chouseknecht)
• Matt Davis (@nitzmahone)
• Yuwei Zhou (@yuwzho)