azure.azcollection.azure_rm_trafficmanager – Manage a Traffic Manager profile.
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_trafficmanager
.
New in version 0.1.2: 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” |
|
The DNS settings of the Traffic Manager profile. |
|
The relative DNS name provided by this Traffic Manager profile. If no provided, name of the Traffic Manager will be used |
|
The DNS Time-To-Live (TTL), in seconds. Default: 60 |
|
The list of endpoints in the Traffic Manager profile. |
|
Specifies the location of the external or nested endpoints when using the ‘Performance’ traffic routing method. |
|
The status of the endpoint. Choices:
|
|
The list of countries/regions mapped to this endpoint when using the ‘Geographic’ traffic routing method. |
|
Fully qualified resource Id for the resource. |
|
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’. |
|
The name of the endpoint. |
|
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. |
|
The fully-qualified DNS name of the endpoint. |
|
The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type ‘ExternalEndpoints’. |
|
The type of the endpoint. Ex- Microsoft.network/TrafficManagerProfiles/ExternalEndpoints. |
|
The weight of this endpoint when using the ‘Weighted’ traffic routing method. Possible values are from 1 to 1000. |
|
Valid azure location. Defaults to ‘global’. |
|
Parent argument. |
|
Parent argument. |
|
The endpoint monitoring settings of the Traffic Manager profile. Default: {“path”: “/”, “port”: 80, “protocol”: “HTTP”} |
|
The monitor interval for endpoints in this profile. |
|
The path relative to the endpoint domain name used to probe for endpoint health. |
|
The TCP port used to probe for endpoint health. |
|
The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health. Choices:
|
|
The monitor timeout for endpoints in this profile. |
|
The number of consecutive failed health check before declaring an endpoint in this profile Degraded after the next failed health check. |
|
Name of the Traffic Manager profile. |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Security profile found in ~/.azure/credentials file. |
|
The status of the Traffic Manager profile. Choices:
|
|
Name of a resource group where the Traffic Manager profile exists or will be created. |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
Assert the state of the Traffic Manager profile. Use Choices:
|
|
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. |
|
The traffic routing method of the Traffic Manager profile. Choices:
|
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 |
Description |
---|---|
Current state of the Traffic Manager Profile Returned: always 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”: null, “id”: “/subscriptions/XXXXXX…XXXXXXXXX/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tmtest/externalEndpoints/e1”, “min_child_endpoints”: null, “name”: “e1”, “priority”: 2, “target”: “1.2.3.4”, “target_resource_id”: null, “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
Hai Cao <t-haicao@microsoft.com>