wbrawner/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update azure_rm_loadbalancer relate module document (#57154)

Browse source
This commit is contained in:
Fred-sun 2019-05-30 10:37:51 -04:00 committed by Sandra McCann
parent 511c385da6
commit 42acf740e4
2 changed files with 81 additions and 58 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

130
lib/ansible/modules/cloud/azure/azure_rm_loadbalancer.py
View file

@ -19,10 +19,10 @@ module: azure_rm_loadbalancer
version_added: "2.4" version_added: "2.4"
short_description: Manage Azure load balancers. short_description: Manage Azure load balancers
description: description:
- Create, update and delete Azure load balancers - Create, update and delete Azure load balancers.
options: options:
resource_group: resource_group:
@ -35,66 +35,75 @@ options:
required: true required: true
state: state:
description: description:
- Assert the state of the load balancer. Use C(present) to create/update a load balancer, or - Assert the state of the load balancer. Use C(present) to create/update a load balancer, or C(absent) to delete one.
C(absent) to delete one.
default: present default: present
choices: choices:
- absent - absent
- present - present
location: location:
description: description:
- Valid azure location. Defaults to location of the resource group. - Valid Azure location. Defaults to location of the resource group.
sku: sku:
description: description:
The load balancer SKU. - The load balancer SKU.
choices: choices:
- Basic - Basic
- Standard - Standard
version_added: 2.6 version_added: '2.6'
frontend_ip_configurations: frontend_ip_configurations:
description: List of frontend IPs to be used description:
- List of frontend IPs to be used.
suboptions: suboptions:
name: name:
description: Name of the frontend ip configuration. description:
- Name of the frontend ip configuration.
required: True required: True
public_ip_address: public_ip_address:
description: Name of an existing public IP address object in the current resource group to associate with the security group. description:
- Name of an existing public IP address object in the current resource group to associate with the security group.
private_ip_address: private_ip_address:
description: The reference of the Public IP resource. description:
version_added: 2.6 - The reference of the Public IP resource.
version_added: '2.6'
private_ip_allocation_method: private_ip_allocation_method:
description: The Private IP allocation method. description:
- The Private IP allocation method.
choices: choices:
- Static - Static
- Dynamic - Dynamic
version_added: 2.6 version_added: '2.6'
subnet: subnet:
description: description:
- The reference of the subnet resource. - The reference of the subnet resource.
- Should be an existing subnet's resource id. - Should be an existing subnet's resource id.
version_added: 2.6 version_added: '2.6'
version_added: 2.5 version_added: '2.5'
backend_address_pools: backend_address_pools:
description: List of backend address pools description:
- List of backend address pools.
suboptions: suboptions:
name: name:
description: Name of the backend address pool. description:
- Name of the backend address pool.
required: True required: True
version_added: 2.5 version_added: '2.5'
probes: probes:
description: List of probe definitions used to check endpoint health. description:
- List of probe definitions used to check endpoint health.
suboptions: suboptions:
name: name:
description: Name of the probe. description:
- Name of the probe.
required: True required: True
port: port:
description: Probe port for communicating the probe. Possible values range from 1 to 65535, inclusive. description:
- Probe port for communicating the probe. Possible values range from 1 to 65535, inclusive.
required: True required: True
protocol: protocol:
description: description:
- The protocol of the end point to be probed. - The protocol of the end point to be probed.
- If 'Tcp' is specified, a received ACK is required for the probe to be successful. - If C(Tcp) is specified, a received ACK is required for the probe to be successful.
- If 'Http' is specified, a 200 OK response from the specified URL is required for the probe to be successful. - If C(Http) is specified, a 200 OK response from the specified URL is required for the probe to be successful.
choices: choices:
- Tcp - Tcp
- Http - Http
@ -102,7 +111,7 @@ options:
description: description:
- The interval, in seconds, for how frequently to probe the endpoint for health status. - The interval, in seconds, for how frequently to probe the endpoint for health status.
- Slightly less than half the allocated timeout period, which allows two full probes before taking the instance out of rotation. - Slightly less than half the allocated timeout period, which allows two full probes before taking the instance out of rotation.
- The default value is 15, the minimum value is 5. - The default value is C(15), the minimum value is C(5).
default: 15 default: 15
fail_count: fail_count:
description: description:
@ -114,8 +123,8 @@ options:
request_path: request_path:
description: description:
- The URI used for requesting health status from the VM. - The URI used for requesting health status from the VM.
- Path is required if a protocol is set to http. Otherwise, it is not allowed. - Path is required if I(protocol=Http). Otherwise, it is not allowed.
version_added: 2.5 version_added: '2.5'
inbound_nat_pools: inbound_nat_pools:
description: description:
- Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. - Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer.
@ -126,13 +135,16 @@ options:
- They have to reference individual inbound NAT rules. - They have to reference individual inbound NAT rules.
suboptions: suboptions:
name: name:
description: Name of the inbound NAT pool. description:
- Name of the inbound NAT pool.
required: True required: True
frontend_ip_configuration_name: frontend_ip_configuration_name:
description: A reference to frontend IP addresses. description:
- A reference to frontend IP addresses.
required: True required: True
protocol: protocol:
description: IP protocol for the NAT pool description:
- IP protocol for the NAT pool.
choices: choices:
- Tcp - Tcp
- Udp - Udp
@ -151,25 +163,30 @@ options:
description: description:
- The port used for internal connections on the endpoint. - The port used for internal connections on the endpoint.
- Acceptable values are between 1 and 65535. - Acceptable values are between 1 and 65535.
version_added: 2.5 version_added: '2.5'
load_balancing_rules: load_balancing_rules:
description: description:
- Object collection representing the load balancing rules Gets the provisioning. - Object collection representing the load balancing rules Gets the provisioning.
suboptions: suboptions:
name: name:
description: name of the load balancing rule. description:
- Name of the load balancing rule.
required: True required: True
frontend_ip_configuration: frontend_ip_configuration:
description: A reference to frontend IP addresses. description:
- A reference to frontend IP addresses.
required: True required: True
backend_address_pool: backend_address_pool:
description: A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs. description:
- A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.
required: True required: True
probe: probe:
description: The name of the load balancer probe this rule should use for health checks. description:
- The name of the load balancer probe this rule should use for health checks.
required: True required: True
protocol: protocol:
description: IP protocol for the load balancing rule. description:
- IP protocol for the load balancing rule.
choices: choices:
- Tcp - Tcp
- Udp - Udp
@ -187,22 +204,22 @@ options:
- The port for the external endpoint. - The port for the external endpoint.
- Frontend port numbers must be unique across all rules within the load balancer. - Frontend port numbers must be unique across all rules within the load balancer.
- Acceptable values are between 0 and 65534. - Acceptable values are between 0 and 65534.
- Note that value 0 enables "Any Port" - Note that value 0 enables "Any Port".
backend_port: backend_port:
description: description:
- The port used for internal connections on the endpoint. - The port used for internal connections on the endpoint.
- Acceptable values are between 0 and 65535. - Acceptable values are between 0 and 65535.
- Note that value 0 enables "Any Port" - Note that value 0 enables "Any Port".
idle_timeout: idle_timeout:
description: description:
- The timeout for the TCP idle connection. - The timeout for the TCP idle connection.
- The value can be set between 4 and 30 minutes. - The value can be set between 4 and 30 minutes.
- The default value is 4 minutes. - The default value is C(4) minutes.
- This element is only used when the protocol is set to TCP. - This element is only used when the protocol is set to TCP.
enable_floating_ip: enable_floating_ip:
description: description:
- Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. - Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.
version_added: 2.5 version_added: '2.5'
inbound_nat_rules: inbound_nat_rules:
description: description:
- Collection of inbound NAT Rules used by a load balancer. - Collection of inbound NAT Rules used by a load balancer.
@ -212,13 +229,16 @@ options:
- They have to reference individual inbound NAT rules. - They have to reference individual inbound NAT rules.
suboptions: suboptions:
name: name:
description: name of the inbound nat rule. description:
- name of the inbound nat rule.
required: True required: True
frontend_ip_configuration: frontend_ip_configuration:
description: A reference to frontend IP addresses. description:
- A reference to frontend IP addresses.
required: True required: True
protocol: protocol:
description: IP protocol for the inbound nat rule. description:
- IP protocol for the inbound nat rule.
choices: choices:
- Tcp - Tcp
- Udp - Udp
@ -228,18 +248,18 @@ options:
- The port for the external endpoint. - The port for the external endpoint.
- Frontend port numbers must be unique across all rules within the load balancer. - Frontend port numbers must be unique across all rules within the load balancer.
- Acceptable values are between 0 and 65534. - Acceptable values are between 0 and 65534.
- Note that value 0 enables "Any Port" - Note that value 0 enables "Any Port".
backend_port: backend_port:
description: description:
- The port used for internal connections on the endpoint. - The port used for internal connections on the endpoint.
- Acceptable values are between 0 and 65535. - Acceptable values are between 0 and 65535.
- Note that value 0 enables "Any Port" - Note that value 0 enables "Any Port".
idle_timeout: idle_timeout:
description: description:
- The timeout for the TCP idle connection. - The timeout for the TCP idle connection.
- The value can be set between 4 and 30 minutes. - The value can be set between 4 and 30 minutes.
- The default value is 4 minutes. - The default value is C(4) minutes.
- This element is only used when the protocol is set to TCP. - This element is only used when I(protocol=Tcp).
enable_floating_ip: enable_floating_ip:
description: description:
- Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. - Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group.
@ -248,8 +268,8 @@ options:
enable_tcp_reset: enable_tcp_reset:
description: description:
- Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. - Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination.
- This element is only used when the C(protocol) is set to C(Tcp). - This element is only used when I(protocol=Tcp).
version_added: 2.8 version_added: '2.8'
public_ip_address_name: public_ip_address_name:
description: description:
- (deprecated) Name of an existing public IP address object to associate with the security group. - (deprecated) Name of an existing public IP address object to associate with the security group.
@ -281,7 +301,7 @@ options:
default: 3 default: 3
probe_request_path: probe_request_path:
description: description:
- (deprecated) The URL that an HTTP probe will use (only relevant if probe_protocol is set to Http). - (deprecated) The URL that an HTTP probe will use (only relevant if I(probe_protocol=Http)).
- This option has been deprecated, and will be removed in 2.9. Use I(probes) instead. - This option has been deprecated, and will be removed in 2.9. Use I(probes) instead.
protocol: protocol:
description: description:
@ -332,8 +352,8 @@ extends_documentation_fragment:
- azure_tags - azure_tags
author: author:
- "Thomas Stringer (@trstringer)" - Thomas Stringer (@trstringer)
- "Yuwei Zhou (@yuwzho)" - Yuwei Zhou (@yuwzho)
''' '''
EXAMPLES = ''' EXAMPLES = '''
@ -373,11 +393,13 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
state: state:
description: Current state of the load balancer description:
- Current state of the load balancer.
returned: always returned: always
type: dict type: dict
changed: changed:
description: Whether or not the resource has changed description:
- Whether or not the resource has changed.
returned: always returned: always
type: bool type: bool
''' '''

9
lib/ansible/modules/cloud/azure/azure_rm_loadbalancer_facts.py
View file

@ -19,7 +19,7 @@ module: azure_rm_loadbalancer_facts
version_added: "2.4" version_added: "2.4"
short_description: Get load balancer facts. short_description: Get load balancer facts
description: description:
- Get facts for a specific load balancer or all load balancers. - Get facts for a specific load balancer or all load balancers.
@ -30,7 +30,7 @@ options:
- Limit results to a specific resource group. - Limit results to a specific resource group.
resource_group: resource_group:
description: description:
- The resource group to search for the desired load balancer - The resource group to search for the desired load balancer.
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'.
@ -39,7 +39,7 @@ extends_documentation_fragment:
- azure - azure
author: author:
- "Thomas Stringer (@trstringer)" - Thomas Stringer (@trstringer)
''' '''
EXAMPLES = ''' EXAMPLES = '''
@ -63,7 +63,8 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
azure_loadbalancers: azure_loadbalancers:
description: List of load balancer dicts. description:
- List of load balancer dicts.
returned: always returned: always
type: list type: list
''' '''