- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# azure_rm_virtualnetworkgateway – Manage Azure virtual network gateways

New in version 2.8.

- Synopsis
- Requirements
- Parameters
- Notes
- See Also
- Examples
- Return Values
- Status

## Synopsis

- Create, update or delete a virtual network gateway(VPN Gateway).
- When creating a VPN Gateway you must provide the name of an existing virtual network.

## Requirements

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

- python >= 2.7
- azure >= 2.0.0

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
ad_user string |  | Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url string added in 2.6 |  | Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile string added in 2.5 | Default: "latest" | Selects an API profile to use when communicating with Azure services. Default value of `latest` is appropriate for public clouds; future values will allow use with Azure Stack.
append_tags boolean | Choices: no yes ← | 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.
auth_source string added in 2.5 | Choices: auto cli credential_file env msi | 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 `auto` if variable is not defined. `auto` will follow the default precedence of module parameters -> environment variables -> default profile in credential file `~/.azure/credentials`. When set to `cli`, the credentials will be sources from the default Azure CLI profile. Can also be set via the `ANSIBLE_AZURE_AUTH_SOURCE` environment variable. When set to `msi`, the host machine must be an azure resource with an enabled MSI extension. `subscription_id` or the environment variable `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 `msi` was added in Ansible 2.6.
bgp_settings - |  | Virtual network gateway's BGP speaker settings.
| asn - / required |  | The BGP speaker's ASN.
cert_validation_mode string added in 2.5 | Choices: ignore validate | 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 `ignore`. Can also be set via credential file profile or the `AZURE_CERT_VALIDATION` environment variable.
client_id string |  | Azure client ID. Use when authenticating with a Service Principal.
cloud_environment string added in 2.4 | Default: "AzureCloud" | For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, `AzureChinaCloud`, `AzureUSGovernment`), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the `AZURE_CLOUD_ENVIRONMENT` environment variable.
enable_bgp - | Default: "no" | Whether BGP is enabled for this virtual network gateway or not.
gateway_type - | Choices: vpn ← express_route | The type of this virtual network gateway.
ip_configurations - |  | List of IP configurations.
| name - / required |  | Name of the IP configuration.
| private_ip_allocation_method - | Choices: dynamic ← static | Private IP allocation method.
| public_ip_address_name - |  | Name of the public IP address. Use 'None' to disable the public IP address.
| subnet - | Default: "GatewaySubnet" | ID of the gateway subnet for VPN.
location - |  | Valid Azure location. Defaults to location of the resource group.
name - / required |  | Name of VPN Gateway.
password string |  | Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile string |  | Security profile found in ~/.azure/credentials file.
resource_group - / required |  | Name of a resource group where VPN Gateway exists or will be created.
secret string |  | Azure client secret. Use when authenticating with a Service Principal.
sku - | Choices: VpnGw1 ← VpnGw2 VpnGw3 | The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.
state - | Choices: absent present ← | State of the VPN Gateway. Use `present` to create or update VPN gateway and `absent` to delete VPN gateway.
subscription_id string |  | Your Azure subscription Id.
tags dictionary |  | 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 string |  | Azure tenant ID. Use when authenticating with a Service Principal.
virtual_network - / required |  | An existing virtual network with which the VPN Gateway will be associated. Required when creating a VPN Gateway. Can be the name of the virtual network. Must be in the same resource group as VPN gateway when specified by name. Can be the resource ID of the virtual network. Can be a dict which contains name and resource_group of the virtual network. aliases: virtual_network_name
vpn_type - | Choices: route_based ← policy_based | The type of this virtual private network.

## Notes

Note

- For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with `az login`.
- Authentication is also possible using a service principal or Active Directory user.
- To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.
- To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.
- 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.

## See Also

See also

Sign in with Azure CLI
  How to authenticate using the `az login` command.

## Examples

    - name: Create virtual network gateway without bgp settings
      azure_rm_virtualnetworkgateway:
        resource_group: myResourceGroup
        name: myVirtualNetworkGateway
        ip_configurations:
          - name: testipconfig
            private_ip_allocation_method: Dynamic
            public_ip_address_name: testipaddr
        virtual_network: myVirtualNetwork
        tags:
          common: "xyz"

    - name: Create virtual network gateway with bgp
      azure_rm_virtualnetworkgateway:
        resource_group: myResourceGroup
        name: myVirtualNetworkGateway
        sku: vpn_gw1
        ip_configurations:
          - name: testipconfig
            private_ip_allocation_method: Dynamic
            public_ip_address_name: testipaddr
        enable_bgp: yes
        virtual_network: myVirtualNetwork
        bgp_settings:
          asn: 65515
          bgp_peering_address: "169.254.54.209"
        tags:
          common: "xyz"

    - name: Delete instance of virtual network gateway
      azure_rm_virtualnetworkgateway:
        resource_group: myResourceGroup
        name: myVirtualNetworkGateway
        state: absent

## Return Values

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

Key | Returned | Description
--- | --- | ---
id string | always | Virtual Network Gateway resource ID. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworkGateways/myV irtualNetworkGateway

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]

### Authors

- Madhura Naniwadekar (@Madhura-CSI)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.