ansible / ansible.builtin / v2.9.17 / module / azure_rm_virtualnetworkgateway Manage Azure virtual network gateways | "added in version" 2.8 of ansible.builtin" Authors: Madhura Naniwadekar (@Madhura-CSI) preview | supported by certifiedansible.builtin.azure_rm_virtualnetworkgateway (v2.9.17) — module
pip
Install with pip install ansible==2.9.17
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.
- 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
sku: choices: - VpnGw1 - VpnGw2 - VpnGw3 default: VpnGw1 description: - The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway. name: description: - Name of VPN Gateway. required: true tags: description: - 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. type: dict state: choices: - absent - present default: present description: - State of the VPN Gateway. Use C(present) to create or update VPN gateway and C(absent) to delete VPN gateway. required: false secret: description: - Azure client secret. Use when authenticating with a Service Principal. type: str tenant: description: - Azure tenant ID. Use when authenticating with a Service Principal. type: str ad_user: description: - Active Directory username. Use when authenticating with an Active Directory user rather than service principal. type: str profile: description: - Security profile found in ~/.azure/credentials file. type: str location: description: - Valid Azure location. Defaults to location of the resource group. required: false password: description: - Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. type: str vpn_type: choices: - route_based - policy_based default: route_based description: - The type of this virtual private network. client_id: description: - Azure client ID. Use when authenticating with a Service Principal. type: str enable_bgp: default: false description: - Whether BGP is enabled for this virtual network gateway or not. api_profile: default: latest description: - Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. type: str version_added: 0.0.1 version_added_collection: azure.azcollection append_tags: default: true description: - 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. type: bool auth_source: choices: - auto - cli - credential_file - env - msi default: auto description: - Controls the source of the credentials to use for authentication. - Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. - When set to C(auto) (the default) the precedence is module parameters -> C(env) -> C(credential_file) -> C(cli). - When set to C(env), the credentials will be read from the environment variables - When set to C(credential_file), it will read the profile from C(~/.azure/credentials). - When set to C(cli), the credentials will be sources from the Azure CLI profile. C(subscription_id) or the environment variable C(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 C(msi), the host machine must be an azure resource with an enabled MSI extension. C(subscription_id) or the environment variable C(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 C(msi) was added in Ansible 2.6. type: str version_added: 0.0.1 version_added_collection: azure.azcollection bgp_settings: description: - Virtual network gateway's BGP speaker settings. suboptions: asn: description: - The BGP speaker's ASN. required: true gateway_type: choices: - vpn - express_route default: vpn description: - The type of this virtual network gateway. resource_group: description: - Name of a resource group where VPN Gateway exists or will be created. required: true subscription_id: description: - Your Azure subscription Id. type: str virtual_network: aliases: - virtual_network_name description: - 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 I(name) and I(resource_group) of the virtual network. required: true cloud_environment: default: AzureCloud description: - For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection ip_configurations: description: - List of IP configurations. suboptions: name: description: - Name of the IP configuration. required: true private_ip_allocation_method: choices: - dynamic - static default: dynamic description: - Private IP allocation method. public_ip_address_name: description: - Name of the public IP address. Use 'None' to disable the public IP address. subnet: default: GatewaySubnet description: - ID of the gateway subnet for VPN. adfs_authority_url: description: - Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. type: str version_added: 0.0.1 version_added_collection: azure.azcollection cert_validation_mode: choices: - ignore - validate description: - 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 C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection
id: description: - Virtual Network Gateway resource ID. returned: always sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworkGateways/myV irtualNetworkGateway type: str