W3cubDocs

/Ansible

azure.azcollection.azure_rm_vpnsite – Manage Azure VpnSite instance

Note

This plugin is part of the azure.azcollection collection (version 1.10.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.

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

New in version 1.5.0: of azure.azcollection

Synopsis

  • Create, update and delete instance of Azure VpnSite.

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-azure.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 Choices/Defaults Comments
ad_user
string
Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
address_space
dictionary
The AddressSpace that contains an array of IP address ranges.
address_prefixes
list / elements=string
A list of address blocks reserved for this virtual network in CIDR notation.
adfs_authority_url
string
added in 0.0.1 of azure.azcollection
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile
string
added in 0.0.1 of azure.azcollection
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 0.0.1 of azure.azcollection
    Choices:
  • auto ←
  • cli
  • credential_file
  • env
  • msi
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.
bgp_properties
dictionary
The set of bgp properties.
asn
integer
The BGP speaker's ASN.
bgp_peering_address
string
The BGP peering address and BGP identifier of this BGP speaker.
bgp_peering_addresses
list / elements=string
BGP peering address with IP configuration ID for virtual network gateway.
custom_bgp_ip_addresses
list / elements=string
The list of custom BGP peering addresses which belong to IP configuration.
default_bgp_ip_addresses
list / elements=string
The list of default BGP peering addresses which belong to IP configuration.
ipconfiguration_id
string
The ID of IP configuration which belongs to gateway.
tunnel_ip_addresses
list / elements=string
The list of tunnel public IP addresses which belong to IP configuration.
peer_weight
integer
The weight added to routes learned from this BGP speaker.
cert_validation_mode
string
added in 0.0.1 of azure.azcollection
    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 0.0.1 of azure.azcollection
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.
device_properties
dictionary
The device properties.
device_model
string
Model of the device.
device_vendor
string
Name of the device Vendor.
link_speed_in_mbps
integer
Link speed.
ip_address
string
The ip-address for the vpn-site.
is_security_site
boolean
    Choices:
  • no
  • yes
IsSecuritySite flag.
location
string
The location of the VpnSite
log_mode
string
Parent argument.
log_path
string
Parent argument.
name
string / required
The name of the VpnSite.
o365_policy
dictionary
Office365 Policy.
break_out_categories
dictionary
Office365 breakout categories.
allow
boolean
    Choices:
  • no
  • yes
Flag to control allow category.
default
boolean
    Choices:
  • no
  • yes
Flag to control default category.
optimize
boolean
    Choices:
  • no
  • yes
Flag to control optimize category.
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 resource group name of the VpnSite.
secret
string
Azure client secret. Use when authenticating with a Service Principal.
site_key
string
The key for vpn-site that can be used for connections.
state
string
    Choices:
  • absent
  • present ←
Assert the state of the VpnSite.
Use present to create or update an VpnSite and absent to delete it.
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.
virtual_wan
dictionary
The VirtualWAN to which the vpnSite belongs.
id
string
The resource ID of the related virtual wan.
vpn_site_links
list / elements=string
List of all vpn site links.
bgp_properties
dictionary
The set of bgp properties.
asn
integer
The BGP speaker's ASN.
bgp_peering_address
string
The BGP peering address and BGP identifier of this BGP speaker.
fqdn
string
FQDN of vpn-site-link.
ip_address
string
The IP address for the vpn site link.
link_properties
dictionary
The link provider properties.
link_provider_name
string
Name of the link provider.
link_speed_in_mbps
integer
Link speed.
name
string
The name of the resource that is unique within a resource group.
This name can be used to access the resource.

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 VpnSite
  azure_rm_vpnsite:
    resource_group: myResourceGroup
    name: vpnSite_name

- name: Delete Vpn Site
  azure_rm_vpnsite:
    resource_group: myResourceGroup
    name: vpnSite_name

Return Values

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

Key Returned Description
state
complex
success
Current state of the vpn site.
device_properties
complex
always
The device properties.
device_vendor
string
always
Name of the device Vendor.

Sample:
{'link_speed_in_mbps': 0}
etag
string
always
A unique read-only string that changes whenever the resource is updated.

Sample:
8d7415fe-d92c-4331-92ea-460aadfb9648
id
string
always
Resource ID.

Sample:
/subscriptions/xxx-xxx/resourceGroups/v-xisuRG/providers/Microsoft.Network/vpnSites/vpn_site_name
is_security_site
boolean
always
IsSecuritySite flag.
location
string
always
Resource location.

Sample:
eastus
name
string
always
Resource name.

Sample:
vpn_site_name
provisioning_state
string
always
The provisioning state of the VPN site resource.

Sample:
Succeeded
tags
dictionary
always
Resource tags.

Sample:
{'key1': 'value1'}
type
string
always
Resource type.

Sample:
Microsoft.Network/vpnSites
virtual_wan
complex
always
The VirtualWAN to which the vpnSite belongs.
id
string
always
Resource ID.

Sample:
/subscriptions/xxx-xxx/resourceGroups/v-xisuRG/providers/Microsoft.Network/virtualWans/virtualwan_name


Authors

  • Fred-Sun (@Fred-Sun)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_vpnsite_module.html