azure.azcollection.azure_rm_vpnsite_info (2.3.0) — module

Install collection

Install with ansible-galaxy collection install azure.azcollection:==2.3.0

Add to requirements.yml

  collections:
    - name: azure.azcollection
      version: 2.3.0

Description

Get info of VpnSite.

Requirements

• 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

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get Vpn Site Info by name
  azure_rm_vpnsite_info:
    resource_group: myResourceGroup
    name: vwan_site_name

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get Vpn Site List By ResourceGroup
  azure_rm_vpnsite_info:
    resource_group: myResourceGroup

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get Vpn Site List By Subscription
  azure_rm_vpnsite_info:

Inputs

    
name:
    description:
    - The name of the VpnSite being retrieved.
    type: str

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.
    - 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.
    type: dict

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

log_mode:
    description:
    - Parent argument.
    type: str

log_path:
    description:
    - Parent argument.
    type: str

password:
    description:
    - Active Directory user password. Use when authenticating with an Active Directory
      user rather than service principal.
    type: str

client_id:
    description:
    - Azure client ID. Use when authenticating with a Service Principal or Managed Identity
      (msi).
    - Can also be set via the C(AZURE_CLIENT_ID) environment variable.
    type: str

thumbprint:
    description:
    - The thumbprint of the private key specified in I(x509_certificate_path).
    - Use when authenticating with a Service Principal.
    - Required if I(x509_certificate_path) is defined.
    type: str
    version_added: 1.14.0
    version_added_collection: azure.azcollection

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

resource_group:
    description:
    - The resource group name of the VpnSite.
    type: str

subscription_id:
    description:
    - Your Azure subscription Id.
    type: str

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

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

x509_certificate_path:
    description:
    - 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.
    type: path
    version_added: 1.14.0
    version_added_collection: azure.azcollection

disable_instance_discovery:
    default: false
    description:
    - 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 C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment
      variable.
    type: bool
    version_added: 2.3.0
    version_added_collection: azure.azcollection

Outputs

vpn_sites:
  contains:
    address_space:
      description:
      - The AddressSpace that contains an array of IP address ranges.
      returned: always
      sample:
        address_prefixes:
        - 10.0.0.0/24
      type: dict
    device_properties:
      description:
      - The device properties.
      returned: always
      sample:
        device_vendor: myVM
        link_speed_in_mbps: 0
      type: dict
    etag:
      description:
      - A unique read-only string that changes whenever the resource is updated.
      returned: always
      sample: 1d8c0731-adc6-4022-9c70-3c389cd73e2a
      type: str
    id:
      description:
      - Resource ID.
      returned: always
      sample: /subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/vpnSites/vwam_site_name
      type: str
    is_security_site:
      description:
      - IsSecuritySite flag.
      returned: always
      sample: false
      type: bool
    location:
      description:
      - Resource location.
      returned: always
      sample: eastus
      type: str
    name:
      description:
      - Resource name.
      returned: always
      sample: vwan_site_name
      type: str
    o365_policy:
      description:
      - Office365 Policy.
      returned: always
      sample:
        break_out_categories:
          allow: false
          default: false
          optimize: false
      type: dict
    provisioning_state:
      description:
      - The provisioning state of the VPN site resource.
      returned: always
      sample: succeeded
      type: str
    tags:
      description:
      - Resource tags.
      returned: always
      sample:
        key1: value1
      type: dict
    type:
      description:
      - Resource type.
      returned: always
      sample: Microsoft.Network/vpnSites
      type: str
    virtual_wan:
      description:
      - The VirtualWAN to which the vpnSite belongs.
      returned: always
      sample:
        id: /subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualWans/vwan_name
      type: dict
    vpn_site_links:
      contains:
        etag:
          description:
          - A unique read-only string that changes whenever the resource is updated.
          returned: always
          sample: 1d8c0731-adc6-4022-9c70-3c389cd73e2a
          type: str
        id:
          description:
          - Resource ID.
          returned: always
          sample: /subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/vpnSites/vwam_site_name
          type: str
        ip_address:
          description:
          - The ip-address for the vpn-site-link.
          returned: always
          sample: 192.168.33.223
          type: str
        link_properties:
          description:
          - The link provider properties.
          returned: always
          sample:
            link_provider_name: azureuser
            link_speed_in_mbps: 100
          type: dict
        name:
          description:
          - 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
          type: str
        type:
          description:
          - Resource type.
          returned: always
          sample: Microsoft.Network/vpnSites
          type: str
      description:
      - List of all vpn site links.
      returned: always
      type: complex
  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
  type: complex

See also

• Sign in with Azure CLI: How to authenticate using the C(az login) command. link