azure.azcollection.azure_rm_virtualnetworkgatewayconnection module – Manage Azure Virtual Network Gateway Connection in a resource group

Note

This module is part of the azure.azcollection collection (version 3.1.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install azure.azcollection. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: azure.azcollection.azure_rm_virtualnetworkgatewayconnection.

New in azure.azcollection 2.7.0

Synopsis

  • Create, update or delete Azure Virtual Network Gateway Connection in a resource group

Requirements

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

  • python >= 2.7

  • The host that executes this module must have the azure.azcollection collection installed via galaxy

  • All python packages listed in collection’s requirements.txt must be installed via pip on the host that executes modules from azure.azcollection

  • Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection

Parameters

Parameter

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 azure.azcollection 0.0.1

Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.

api_profile

string

added in azure.azcollection 0.0.1

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.

Default: "latest"

append_tags

boolean

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.

Choices:

  • false

  • true ← (default)

auth_source

string

added in azure.azcollection 0.0.1

Controls the source of the credentials to use for authentication.

Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.

When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli.

When set to env, the credentials will be read from the environment variables

When set to credential_file, it will read the profile from ~/.azure/credentials.

When set to cli, the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable 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 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.

Choices:

  • "auto" ← (default)

  • "cli"

  • "credential_file"

  • "env"

  • "msi"

authorization_key

string

The authorizationKey.

cert_validation_mode

string

added in azure.azcollection 0.0.1

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.

Choices:

  • "ignore"

  • "validate"

client_id

string

Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi).

Can also be set via the AZURE_CLIENT_ID environment variable.

cloud_environment

string

added in azure.azcollection 0.0.1

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.

Default: "AzureCloud"

connection_protocol

string

Connection protocol used for this connection.

Choices:

  • "IKEv2"

  • "IKEv1"

connection_type

string

Gateway connection type.

Choices:

  • "IPsec"

  • "Vnet2Vnet"

  • "ExpressRoute"

  • "VPNClient"

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

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 AZURE_DISABLE_INSTANCE_DISCOVERY environment variable.

Choices:

  • false ← (default)

  • true

dpd_timeout_seconds

integer

The dead peer detection timeout of this connection in seconds.

enable_bgp

boolean

EnableBgp flag.

Choices:

  • false

  • true

express_route_gateway_bypass

boolean

Bypass ExpressRoute Gateway for data forwarding.

Choices:

  • false

  • true

local_network_gateway2

string

The reference to local network gateway resource.

location

string

The location of the network gateway connection.

log_mode

string

Parent argument.

log_path

string

Parent argument.

name

string / required

The name of the network gateway connection.

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

string / required

The network gateway connection’s resource group.

routing_weight

integer

The routing weight.

secret

string

Azure client secret. Use when authenticating with a Service Principal.

shared_key

string

The IPSec shared key.

state

string

Use present to create or update a virtual network gateway connection.

Use absent to delete the virtual network gateway connection.

Choices:

  • "absent"

  • "present" ← (default)

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.

Currently, Azure DNS zones and Traffic Manager services also don’t allow the use of spaces in the tag.

Azure Front Door doesn’t support the use of

Azure Automation and Azure CDN only support 15 tags on resources.

tenant

string

Azure tenant ID. Use when authenticating with a Service Principal.

thumbprint

string

added in azure.azcollection 1.14.0

The thumbprint of the private key specified in x509_certificate_path.

Use when authenticating with a Service Principal.

Required if x509_certificate_path is defined.

use_local_azure_ip_address

boolean

Use private local Azure IP for the connection.

Choices:

  • false

  • true

use_policy_based_traffic_selectors

boolean

Enable policy-based traffic selectors.

Choices:

  • false

  • true

virtual_network_gateway1

string

The reference to virtual network gateway resource.

virtual_network_gateway2

string

The reference to virtual network gateway resource.

x509_certificate_path

path

added in azure.azcollection 1.14.0

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.

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 a new virtual network gateway connection
  azure_rm_virtualnetworkgatewayconnection:
    resource_group: "{{ resource_group }}"
    name: "new{{ rpfx }}"
    virtual_network_gateway1: "{{ virtual_network_gateway1 }}"
    virtual_network_gateway2: "{{ virtual_network_gateway2 }}"
    local_network_gateway2: "{{ local_network_gateway2 }}"
    authorization_key: Password@0329
    connection_type: Vnet2Vnet
    connection_protocol: IKEv2
    routing_weight: 1
    dpd_timeout_seconds: 60
    enable_bgp: false
    use_local_azure_ip_address: false
    use_policy_based_traffic_selectors: false
    express_route_gateway_bypass: false
    tags:
      key1: value1

- name: Delete network gateway connection
  virtualnetworkgatewayconnection:
    resource_group: "{{ resource_group }}"
    name: "localgateway-name"
    state: absent

Return Values

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

Key

Description

state

complex

Current state of the Azure Local Network Gateway resource.

Returned: always

authorization_key

string

The authorizationKey.

Returned: always

Sample: "308201E806092A864********************78B9FADDAC2D"

connection_mode

string

The connection mode for this connection.

Returned: always

Sample: "Default"

connection_protocol

string

Connection protocol used for this connection.

Returned: always

Sample: "IKEv2"

connection_type

string

Gateway connection type.

Returned: always

Sample: "Vnet2Vnet"

dpd_timeout_seconds

integer

The dead peer detection timeout of this connection in seconds.

Returned: always

Sample: 45

enable_bgp

boolean

EnableBgp flag.

Returned: always

Sample: false

etag

string

A unique read-only string that changes whenever the resource is updated.

Returned: always

Sample: "58b6f0c2-7d7c-4666-a62e-6416b4e00c83"

express_route_gateway_bypass

boolean

Bypass ExpressRoute Gateway for data forwarding.

Returned: always

Sample: false

id

string

The resource ID.

Returned: always

Sample: "/subscriptions/xxx-xxx/resourceGroups/rg/providers/Microsoft.Network/connections/fredvnet"

ipsec_policies

list / elements=string

The IPSec Policies to be considered by this connection.

Returned: always

Sample: []

location

string

The resource location.

Returned: always

Sample: "eastus"

name

string

The resource name.

Returned: always

Sample: "fredvnetconnection"

provisioning_state

string

The provisioning state of the virtual network gateway connection resource.

Returned: always

Sample: "Succeeded"

resource_group

string

The resource group of the virtual network gateway connection.

Returned: always

Sample: "rg"

routing_weight

integer

The routing weight.

Returned: always

Sample: 0

shared_key

string

The IPSec shared key.

Returned: always

tags

dictionary

The resource tags.

Returned: always

Sample: {"key1": "value1"}

traffic_selector_policies

list / elements=string

The Traffic Selector Policies to be considered by this connection.

Returned: always

Sample: []

use_local_azure_ip_address

boolean

Use private local Azure IP for the connection.

Returned: always

Sample: false

use_policy_based_traffic_selectors

boolean

Enable policy-based traffic selectors.

Returned: always

Sample: false

virtual_network_gateway1

complex

The reference to virtual network gateway resource.

Returned: always

id

string

The ID of the virtul network gateway resource.

Returned: always

Sample: "/subscriptions/xxx-xxx/resourceGroups/rg/providers/Microsoft.Network/virtualNetworkGateways/fredvng"

virtual_network_gateway2

complex

The reference to virtual network gateway resource.

Returned: always

id

string

The ID of the virtul network gateway resource.

Returned: always

Sample: "/subscriptions/xxx-xxx/resourceGroups/rg/providers/Microsoft.Network/virtualNetworkGateways/fredvng02"

Authors

  • xuzhang3 (@xuzhang3)

  • Fred Sun (@Fred-sun)