W3cubDocs

/Ansible 2.10

azure.azcollection.azure_rm_trafficmanager – Manage a Traffic Manager profile.

Note

This plugin is part of the azure.azcollection collection.

To install it use: ansible-galaxy collection install azure.azcollection.

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

New in version 0.1.2: of azure.azcollection

Synopsis

  • Create, update and delete a Traffic Manager profile.

Requirements

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

  • python >= 2.7
  • azure >= 2.0.0

Parameters

Parameter Choices/Defaults 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 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.
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.
dns_config
string
The DNS settings of the Traffic Manager profile.
relative_name
string
The relative DNS name provided by this Traffic Manager profile.
If no provided, name of the Traffic Manager will be used
ttl
string
Default:
60
The DNS Time-To-Live (TTL), in seconds.
endpoints
string
The list of endpoints in the Traffic Manager profile.
endpoint_location
string
Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method.
endpoint_status
string
    Choices:
  • Enabled
  • Disabled
The status of the endpoint.
geo_mapping
string
The list of countries/regions mapped to this endpoint when using the 'Geographic' traffic routing method.
id
string
Fully qualified resource Id for the resource.
min_child_endpoints
string
The minimum number of endpoints that must be available in the child profile in order for the parent profile to be considered available.
Only applicable to endpoint of type 'NestedEndpoints'.
name
string / required
The name of the endpoint.
priority
string
The priority of this endpoint when using the 'Priority' traffic routing method.
Possible values are from 1 to 1000, lower values represent higher priority.
This is an optional parameter. If specified, it must be specified on all endpoints.
No two endpoints can share the same priority value.
target
string
The fully-qualified DNS name of the endpoint.
target_resource_id
string
The Azure Resource URI of the of the endpoint.
Not applicable to endpoints of type 'ExternalEndpoints'.
type
string / required
The type of the endpoint. Ex- Microsoft.network/TrafficManagerProfiles/ExternalEndpoints.
weight
string
The weight of this endpoint when using the 'Weighted' traffic routing method.
Possible values are from 1 to 1000.
location
string
Valid azure location. Defaults to 'global'.
monitor_config
string
Default:
{"path": "/", "port": 80, "protocol": "HTTP"}
The endpoint monitoring settings of the Traffic Manager profile.
interval_in_seconds
string
The monitor interval for endpoints in this profile.
path
string
The path relative to the endpoint domain name used to probe for endpoint health.
port
string
The TCP port used to probe for endpoint health.
protocol
string
    Choices:
  • HTTP
  • HTTPS
  • TCP
The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health.
timeout_in_seconds
string
The monitor timeout for endpoints in this profile.
tolerated_number_of_failures
string
The number of consecutive failed health check before declaring an endpoint in this profile Degraded after the next failed health check.
name
string / required
Name of the Traffic Manager profile.
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.
profile_status
string
    Choices:
  • Enabled ←
  • Disabled
The status of the Traffic Manager profile.
resource_group
string / required
Name of a resource group where the Traffic Manager profile exists or will be created.
secret
string
Azure client secret. Use when authenticating with a Service Principal.
state
string
    Choices:
  • absent
  • present ←
Assert the state of the Traffic Manager profile. Use present to create or update a Traffic Manager profile 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.
tenant
string
Azure tenant ID. Use when authenticating with a Service Principal.
traffic_routing_method
string
    Choices:
  • Performance ←
  • Priority
  • Weighted
  • Geographic
The traffic routing method of the Traffic Manager profile.

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 Traffic Manager Profile
  azure_rm_trafficmanager:
    name: tmtest
    resource_group: tmt
    location: global
    profile_status: Enabled
    traffic_routing_method: Priority
    dns_config:
      relative_name: tmtest
      ttl: 60
    monitor_config:
      protocol: HTTPS
      port: 80
      path: '/'
    endpoints:
      - name: e1
        type: Microsoft.network/TrafficManagerProfiles/ExternalEndpoints
        endpoint_location: West US 2
        endpoint_status: Enabled
        priority: 2
        target: 1.2.3.4
        weight: 1
    tags:
      Environment: Test

- name: Delete a Traffic Manager Profile
  azure_rm_trafficmanager:
    state: absent
    name: tmtest
    resource_group: tmt

Return Values

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

Key Returned Description
state
dictionary
always
Current state of the Traffic Manager Profile

Sample:
{'dns_config': {'fqdn': 'tmtest.trafficmanager.net', 'relative_name': 'tmtest', 'ttl': 60}, 'endpoints': [{'endpoint_location': 'West US 2', 'endpoint_monitor_status': 'Degraded', 'endpoint_status': 'Enabled', 'geo_mapping': None, 'id': '/subscriptions/XXXXXX...XXXXXXXXX/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tmtest/externalEndpoints/e1', 'min_child_endpoints': None, 'name': 'e1', 'priority': 2, 'target': '1.2.3.4', 'target_resource_id': None, 'type': 'Microsoft.Network/trafficManagerProfiles/externalEndpoints', 'weight': 1}], 'id': '/subscriptions/XXXXXX...XXXXXXXXX/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tmtest', 'location': 'global', 'monitor_config': {'interval_in_seconds': 30, 'path': '/', 'port': 80, 'profile_monitor_status': 'Degraded', 'protocol': 'HTTPS', 'timeout_in_seconds': 10, 'tolerated_number_of_failures': 3}, 'name': 'tmtest', 'profile_status': 'Enabled', 'tags': {'Environment': 'Test'}, 'traffic_routing_method': 'Priority', 'type': 'Microsoft.Network/trafficManagerProfiles'}


Authors

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