archive
/
ansible
mirror of https://github.com/ansible/ansible.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update azure_rm_trafficmanagerprofile related document (#58616)

Browse Source 
* Update azure_rm_trafficmanagerprofile related document
pull/55677/head
Fred-sun 5 years ago committed by Sandra McCann
parent 4e230dbfb6
commit b2554ab3b7
2 changed files with 77 additions and 33 deletions
Show Stats Download Patch File Download Diff File

25
lib/ansible/modules/cloud/azure/azure_rm_trafficmanagerprofile.py
Unescape Escape View File

@ -15,7 +15,7 @@ DOCUMENTATION = '''
--- ---
module: azure_rm_trafficmanagerprofile module: azure_rm_trafficmanagerprofile
version_added: "2.7" version_added: "2.7"
short_description: Manage Azure Traffic Manager profile. short_description: Manage Azure Traffic Manager profile
description: description:
- Create, update and delete a Traffic Manager profile. - Create, update and delete a Traffic Manager profile.
@ -37,8 +37,8 @@ options:
- present - present
location: location:
description: description:
- Valid azure location. Defaults to 'global' because in default public Azure cloud, Traffic Manager profile can only be deployed globally. - Valid Azure location. Defaults to C(global) because in default public Azure cloud, Traffic Manager profile can only be deployed globally.
- Reference https://docs.microsoft.com/en-us/azure/traffic-manager/quickstart-create-traffic-manager-profile#create-a-traffic-manager-profile - Reference U(https://docs.microsoft.com/en-us/azure/traffic-manager/quickstart-create-traffic-manager-profile#create-a-traffic-manager-profile).
default: global default: global
profile_status: profile_status:
description: description:
@ -63,10 +63,11 @@ options:
relative_name: relative_name:
description: description:
- The relative DNS name provided by this Traffic Manager profile. - The relative DNS name provided by this Traffic Manager profile.
- If not provided, name of the Traffic Manager will be used - If not provided, name of the Traffic Manager will be used.
ttl: ttl:
description: description:
- The DNS Time-To-Live (TTL), in seconds. - The DNS Time-To-Live (TTL), in seconds.
type: int
default: 60 default: 60
monitor_config: monitor_config:
description: description:
@ -74,7 +75,7 @@ options:
suboptions: suboptions:
protocol: protocol:
description: description:
- The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health. - The protocol C(HTTP), C(HTTPS) or C(TCP) used to probe for endpoint health.
choices: choices:
- HTTP - HTTP
- HTTPS - HTTPS
@ -88,9 +89,11 @@ options:
interval: interval:
description: description:
- The monitor interval for endpoints in this profile in seconds. - The monitor interval for endpoints in this profile in seconds.
type: int
timeout: timeout:
description: description:
- The monitor timeout for endpoints in this profile in seconds. - The monitor timeout for endpoints in this profile in seconds.
type: int
tolerated_failures: tolerated_failures:
description: description:
- The number of consecutive failed health check before declaring an endpoint in this profile Degraded after the next failed health check. - The number of consecutive failed health check before declaring an endpoint in this profile Degraded after the next failed health check.
@ -104,8 +107,8 @@ extends_documentation_fragment:
- azure_tags - azure_tags
author: author:
- "Hai Cao (@caohai) <t-haicao@microsoft.com>" - Hai Cao (@caohai)
- "Yunge Zhu (@yungezz) <yungez@microsoft.com>" - Yunge Zhu (@yungezz)
''' '''
@ -135,12 +138,14 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
id: id:
description: The ID of the traffic manager profile description:
- The ID of the traffic manager profile.
returned: when traffic manager profile exists returned: when traffic manager profile exists
type: str type: str
example: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tmtest" sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tmtest"
endpoints: endpoints:
description: List of endpoint IDs attached to the profile description:
- List of endpoint IDs attached to the profile.
returned: when traffic manager endpoints exists returned: when traffic manager endpoints exists
type: list type: list
sample: [ sample: [

69
lib/ansible/modules/cloud/azure/azure_rm_trafficmanagerprofile_facts.py
Unescape Escape View File

@ -29,7 +29,7 @@ options:
- Limit results to a specific Traffic Manager profile. - Limit results to a specific Traffic Manager profile.
resource_group: resource_group:
description: description:
- The resource group to search for the desired Traffic Manager profile - The resource group to search for the desired Traffic Manager profile.
tags: tags:
description: description:
- Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. - Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
@ -38,8 +38,8 @@ extends_documentation_fragment:
- azure - azure
author: author:
- "Hai Cao (@caohai) <t-haicao@microsoft.com>" - Hai Cao (@caohai)
- "Yunge Zhu (@yungezz) <yungez@microsoft.com>" - Yunge Zhu (@yungezz)
''' '''
EXAMPLES = ''' EXAMPLES = '''
@ -59,7 +59,8 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
tms: tms:
description: List of Traffic Manager profiles. description:
- List of Traffic Manager profiles.
returned: always returned: always
type: complex type: complex
contains: contains:
@ -78,127 +79,165 @@ tms:
state: state:
description: description:
- The state of the Traffic Manager profile. - The state of the Traffic Manager profile.
returned: always
type: str type: str
sample: present sample: present
location: location:
description: description:
- Location of the Traffic Manager profile. - Location of the Traffic Manager profile.
returned: always
type: str type: str
sample: global sample: global
profile_status: profile_status:
description: description:
- The status of the Traffic Manager profile. - The status of the Traffic Manager profile.
returned: always
type: str type: str
sample: Enabled sample: Enabled
routing_method: routing_method:
description: description:
- The traffic routing method of the Traffic Manager profile. - The traffic routing method of the Traffic Manager profile.
returned: always
type: str type: str
sample: performance sample: performance
dns_config: dns_config:
description: description:
- The DNS settings of the Traffic Manager profile. - The DNS settings of the Traffic Manager profile.
returned: always
type: complex type: complex
sample: contains:
relative_name: testTm relative_name:
fqdn: testTm.trafficmanager.net description:
ttl: 60 - The relative DNS name provided by the Traffic Manager profile.
returned: always
type: str
sample: testTm
fqdn:
description:
- The fully-qualified domain name(FQDN) of the Traffic Manager profile.
returned: always
type: str
sample: testTm.trafficmanager.net
ttl:
description:
- The DNS Time-To-Live(TTL), in seconds.
returned: always
type: int
sample: 60
monitor_config: monitor_config:
description: description:
- The endpoint monitoring settings of the Traffic Manager profile. - The endpoint monitoring settings of the Traffic Manager profile.
returned: always
type: complex type: complex
contains: contains:
protocol: protocol:
description: description:
- The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health. - The protocol C(HTTP), C(HTTPS) or C(TCP) used to probe for endpoint health.
returned: always
type: str type: str
sample: HTTP sample: HTTP
port: port:
description: description:
- The TCP port used to probe for endpoint health. - The TCP port used to probe for endpoint health.
returned: always
type: int type: int
sample: 80 sample: 80
path: path:
description: description:
- The path relative to the endpoint domain name used to probe for endpoint health. - The path relative to the endpoint domain name used to probe for endpoint health.
returned: always
type: str type: str
sample: / sample: /
interval: interval:
description: description:
- The monitor interval for endpoints in this profile in seconds. - The monitor interval for endpoints in this profile in seconds.
returned: always
type: int type: int
sample: 10 sample: 10
timeout: timeout:
description: description:
- The monitor timeout for endpoints in this profile in seconds. - The monitor timeout for endpoints in this profile in seconds.
returned: always
type: int type: int
sample: 30 sample: 30
tolerated_failures: tolerated_failures:
description: description:
- The number of consecutive failed health check before declaring an endpoint Degraded after the next failed health check. - The number of consecutive failed health check before declaring an endpoint Degraded after the next failed health check.
returned: always
type: int type: int
sample: 3 sample: 3
endpoints: endpoints:
description: description:
- The list of endpoints in the Traffic Manager profile. - The list of endpoints in the Traffic Manager profile.
type: list returned: always
element: complex type: complex
contains: contains:
id: id:
description: description:
- Fully qualified resource Id for the resource. - Fully qualified resource ID for the resource.
returned: always
type: str type: str
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/trafficMan sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/trafficMan
agerProfiles/tmtest/externalEndpoints/e1" agerProfiles/tmtest/externalEndpoints/e1"
name: name:
description: description:
- The name of the endpoint. - The name of the endpoint.
returned: always
type: str type: str
sample: e1 sample: e1
type: type:
description: description:
- The type of the endpoint. - The type of the endpoint.
returned: always
type: str type: str
sample: external_endpoints sample: external_endpoints
target_resource_id: target_resource_id:
description: description:
- The Azure Resource URI of the of the endpoint. - The Azure Resource URI of the of the endpoint.
returned: always
type: str type: str
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ClassicCompute/dom sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ClassicCompute/dom
ainNames/vscjavaci" ainNames/vscjavaci"
target: target:
description: description:
- The fully-qualified DNS name of the endpoint. - The fully-qualified DNS name of the endpoint.
returned: always
type: str type: str
sample: 8.8.8.8 sample: 8.8.8.8
status: status:
description: description:
- The status of the endpoint. - The status of the endpoint.
returned: always
type: str type: str
sample: Enabled sample: Enabled
weight: weight:
description: description:
- The weight of this endpoint when the profile has routing_method C(weighted). - The weight of this endpoint when the profile has I(routing_method=weighted).
returned: always
type: int type: int
sample: 10 sample: 10
priority: priority:
description: description:
- The priority of this endpoint when the profile has routing_method C(priority). - The priority of this endpoint when the profile has I(routing_method=priority).
returned: always
type: str type: str
sample: 3 sample: 3
location: location:
description: description:
- The location of endpoints when type is C(external_endpoints) or C(nested_endpoints), and profile routing_method is (performance). - The location of endpoints when I(type=external_endpoints) or I(type=nested_endpoints), and profile I(routing_method=performance).
returned: always
type: str type: str
sample: East US sample: East US
min_child_endpoints: min_child_endpoints:
description: description:
- The minimum number of endpoints that must be available in the child profile to make the parent profile available. - The minimum number of endpoints that must be available in the child profile to make the parent profile available.
returned: always
type: int type: int
sample: 3 sample: 3
geo_mapping: geo_mapping:
description: description:
- The list of countries/regions mapped to this endpoint when the profile has routing_method C(geographic). - The list of countries/regions mapped to this endpoint when the profile has routing_method C(geographic).
returned: always
type: list type: list
sample: [ sample: [
"GEO-NA", "GEO-NA",

Write Preview
Loading…
Cancel
Save