W3cubDocs

/Ansible

azure_rm_virtualnetwork - Manage Azure virtual networks.

New in version 2.1.

Synopsis

Create, update or delete a virtual networks. Allows setting and updating the available IPv4 address ranges and setting custom DNS servers. Use the azure_rm_subnet module to associate subnets with a virtual network.

Requirements (on host that executes module)

  • python >= 2.7
  • azure == 2.0.0rc5

Options

parameter required default choices comments
ad_user
 no
Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
address_prefixes_cidr
 no
List of IPv4 address ranges where each is formatted using CIDR notation. Required when creating a new virtual network or using purge_address_prefixes.
aliases: address_prefixes
append_tags
 no True
Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata.
client_id
 no
Azure client ID. Use when authenticating with a Service Principal.
dns_servers
 no
Custom list of DNS servers. Maximum length of two. The first server in the list will be treated as the Primary server. This is an explicit list. Existing DNS servers will be replaced with the specified list. Use the purge_dns_servers option to remove all custom DNS servers and revert to default Azure servers.
location
 no resource_group location
Valid azure location. Defaults to location of the resource group.
name
 yes
name of the virtual network.
password
 no
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile
 no
Security profile found in ~/.azure/credentials file.
purge_address_prefixes
 no
Use with state present to remove any existing address_prefixes.
purge_dns_servers
 no
Use with state present to remove existing DNS servers, reverting to default Azure servers. Mutually exclusive with dns_servers.
resource_group
 yes
name of resource group.
secret
 no
Azure client secret. Use when authenticating with a Service Principal.
state
 no present
  • absent
  • present
Assert the state of the virtual network. Use 'present' to create or update and 'absent' to delete.
subscription_id
 no
Your Azure subscription Id.
tags
 no
Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false.
tenant
 no
Azure tenant ID. Use when authenticating with a Service Principal.

Examples

- name: Create a virtual network
  azure_rm_virtualnetwork:
    name: foobar
    resource_group: Testing
    address_prefixes_cidr:
        - "10.1.0.0/16"
        - "172.100.0.0/16"
    dns_servers:
        - "127.0.0.1"
        - "127.0.0.2"
    tags:
        testing: testing
        delete: on-exit

- name: Delete a virtual network
  azure_rm_virtualnetwork:
    name: foobar
    resource_group: Testing
    state: absent

Return Values

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

name description returned type sample
state Current state of the virtual network. always dict {'dns_servers': ['127.0.0.1', '127.0.0.3'], 'name': 'my_test_network', 'tags': None, 'provisioning_state': 'Succeeded', 'etag': 'W/"0712e87c-f02f-4bb3-8b9e-2da0390a3886"', 'location': 'eastus', 'type': 'Microsoft.Network/virtualNetworks', 'id': '/subscriptions/XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX/resourceGroups/Testing/providers/Microsoft.Network/virtualNetworks/my_test_network', 'address_prefixes': ['10.1.0.0/16', '172.100.0.0/16']}

Notes

Note

For authentication with Azure you can pass parameters, set environment variables or use a profile stored in ~/.azure/credentials. Authentication is possible using a service principal or Active Directory user. To authenticate via service principal pass subscription_id, client_id, secret and tenant or set set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.

Note

To Authentication via Active Directory user pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.

Note

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.

This is a Core Module

For more information on what this means please read Core Modules

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/azure_rm_virtualnetwork_module.html