azure.azcollection.azure_rm_vpnsite_info – Get VpnSite info
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_info
.
New in version 1.5.0: of azure.azcollection
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 |
Comments |
---|---|
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. |
|
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. |
|
Selects an API profile to use when communicating with Azure services. Default value of Default: “latest” |
|
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:
|
|
Controls the source of the credentials to use for authentication. Can also be set via the When set to When set to When set to When set to When set to The Choices:
|
|
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 Choices:
|
|
Azure client ID. Use when authenticating with a Service Principal. |
|
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, Default: “AzureCloud” |
|
Parent argument. |
|
Parent argument. |
|
The name of the VpnSite being retrieved. |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Security profile found in ~/.azure/credentials file. |
|
The resource group name of the VpnSite. |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
Your Azure subscription Id. |
|
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. |
|
Azure tenant ID. 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: Get Vpn Site Info by name
azure_rm_vpnsite_info:
resource_group: myResourceGroup
name: vwan_site_name
- name: Get Vpn Site List By ResourceGroup
azure_rm_vpnsite_info:
resource_group: myResourceGroup
- name: Get Vpn Site List By Subscription
azure_rm_vpnsite_info:
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A list of dict results where the key is the name of the VpnSite and the values are the facts for that VpnSite. Returned: always |
|
The AddressSpace that contains an array of IP address ranges. Returned: always Sample: {“address_prefixes”: [“10.0.0.0/24”]} |
|
The device properties. Returned: always Sample: {“device_vendor”: “myVM”, “link_speed_in_mbps”: 0} |
|
A unique read-only string that changes whenever the resource is updated. Returned: always Sample: “1d8c0731-adc6-4022-9c70-3c389cd73e2a” |
|
Resource ID. Returned: always Sample: “/subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/vpnSites/vwam_site_name” |
|
IsSecuritySite flag. Returned: always Sample: false |
|
Resource location. Returned: always Sample: “eastus” |
|
Resource name. Returned: always Sample: “vwan_site_name” |
|
Office365 Policy. Returned: always Sample: {“break_out_categories”: {“allow”: false, “default”: false, “optimize”: false}} |
|
The provisioning state of the VPN site resource. Returned: always Sample: “succeeded” |
|
Resource tags. Returned: always Sample: {“key1”: “value1”} |
|
Resource type. Returned: always Sample: “Microsoft.Network/vpnSites” |
|
The VirtualWAN to which the vpnSite belongs. Returned: always Sample: {“id”: “/subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualWans/vwan_name”} |
|
List of all vpn site links. Returned: always |
|
A unique read-only string that changes whenever the resource is updated. Returned: always Sample: “1d8c0731-adc6-4022-9c70-3c389cd73e2a” |
|
Resource ID. Returned: always Sample: “/subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/vpnSites/vwam_site_name” |
|
The ip-address for the vpn-site-link. Returned: always Sample: “192.168.33.223” |
|
The link provider properties. Returned: always Sample: {“link_provider_name”: “azureuser”, “link_speed_in_mbps”: 100} |
|
The name of the resource that is unique within a resource group. This name can be used to access the resource. Returned: always Sample: “azureuser” |
|
Resource type. Returned: always Sample: “Microsoft.Network/vpnSites” |
Authors
Fred-Sun (@Fred-Sun)