cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Backport/2.8/docs module changes (#56497)

Browse source 
* [doc] command module: mention all parameter types (#56396)

(cherry picked from commit 8968d41599)

* update azure_rm_autoscale document (#56388)

(cherry picked from commit 49ecfdbc10)

* [doc] expect module: mention all parameter types (#56394)

(cherry picked from commit 7f41cc40e6)

* update azure_rm_appgateway document (#56339)

(cherry picked from commit 84f5666aab)

* update azure_rm_appserviceplan related module documents  (#56348)

(cherry picked from commit 22d7e7ea0b)

* Small typo fix in documentation (#56480): documentation was probably C&P'd from user, leaving a "useradd" mention where a "groupadd" should be.

(cherry picked from commit 6182f368e7)

* Update ovirt_vnic_profile.py (#56466): Update documentation to reflect module name

(cherry picked from commit db42cf5873)

* clean backport of PR 56355, clarify config cli usage

(not actually cherry-picked due to conflicts, but see PR mentioned)

* gcp_compute_target_proxy does not exist, update deprecated redirect (#56496)

(cherry picked from commit 7636f36a8a)
This commit is contained in:
Alicia Cozine 2019-05-16 20:39:24 -05:00 • committed by GitHub
parent 94e24d1039
commit 22511a4eee
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 176 additions and 134 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
lib/ansible/cli/config.py
View file

@ -39,7 +39,7 @@ class ConfigCLI(CLI):
super(ConfigCLI, self).init_parser(
usage="usage: %%prog [%s] [--help] [options] [ansible.cfg]" % "|".join(sorted(self.VALID_ACTIONS)),
epilog="\nSee '%s <command> --help' for more information on a specific command.\n\n" % os.path.basename(sys.argv[0]),
desc="View, edit, and manage ansible configuration.",
desc="View ansible configuration.",
)
self.parser.add_option('-c', '--config', dest='config_file',
help="path to configuration file, defaults to first file found in precedence.")

68
lib/ansible/modules/cloud/azure/azure_rm_appgateway.py
View file

@ -17,7 +17,7 @@ DOCUMENTATION = '''
---
module: azure_rm_appgateway
version_added: "2.7"
short_description: Manage Application Gateway instance.
short_description: Manage Application Gateway instance
description:
- Create, update and delete instance of Application Gateway.
@ -134,18 +134,18 @@ options:
suboptions:
data:
description:
- Certificate public data - base64 encoded pfx
- Certificate public data - base64 encoded pfx.
name:
description:
- Name of the resource that is unique within a resource group. This name can be used to access the resource.
redirect_configurations:
version_added: "2.8"
description:
- Redirect configurations of the application gateway resource
- Redirect configurations of the application gateway resource.
suboptions:
redirect_type:
description:
- Redirection type
- Redirection type.
choices:
- 'permanent'
- 'found'
@ -153,16 +153,16 @@ options:
- 'temporary'
target_listener:
description:
- Reference to a listener to redirect the request to
- Reference to a listener to redirect the request to.
include_path:
description:
- Include path in the redirected url
- Include path in the redirected url.
include_query_string:
description:
- Include query string in the redirected url
- Include query string in the redirected url.
name:
description:
- Name of the resource that is unique within a resource group
- Name of the resource that is unique within a resource group.
ssl_certificates:
description:
- SSL certificates of the application gateway resource.
@ -170,9 +170,11 @@ options:
data:
description:
- Base-64 encoded pfx certificate.
- Only applicable in PUT Request.
password:
description:
- Password for the pfx file specified in I(data).
- Only applicable in PUT request.
name:
description:
- Name of the resource that is unique within a resource group. This name can be used to access the resource.
@ -204,7 +206,7 @@ options:
suboptions:
port:
description:
- Frontend port
- Frontend port.
name:
description:
- Name of the resource that is unique within a resource group. This name can be used to access the resource.
@ -214,14 +216,14 @@ options:
suboptions:
backend_addresses:
description:
- List of backend addresses
- List of backend addresses.
suboptions:
fqdn:
description:
- Fully qualified domain name (FQDN).
ip_address:
description:
- IP address
- IP address.
name:
description:
- Resource that is unique within a resource group. This name can be used to access the resource.
@ -232,41 +234,49 @@ options:
suboptions:
name:
description:
- Name
- Name of the I(probe) that is unique within an Application Gateway.
protocol:
description:
- Protocol
- The protocol used for the I(probe).
choices:
- 'http'
- 'https'
host:
description:
- Host
- Host name to send the I(probe) to.
path:
description:
- Path
- Relative path of I(probe).
- Valid path starts from '/'.
- Probe is sent to <Protocol>://<host>:<port><path>.
timeout:
description:
- Timeout
- The probe timeout in seconds.
- Probe marked as failed if valid response is not received with this timeout period.
- Acceptable values are from 1 second to 86400 seconds.
interval:
description:
- Interval
- The probing interval in seconds.
- This is the time interval between two consecutive probes.
- Acceptable values are from 1 second to 86400 seconds.
unhealthy_threshold:
description:
- Unhealthy Threshold
- The I(probe) retry count.
- Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold.
- Acceptable values are from 1 second to 20.
backend_http_settings_collection:
description:
- Backend http settings of the application gateway resource.
suboptions:
probe:
description:
- Probe
- Probe resource of an application gateway.
port:
description:
- Port
- The destination port on the backend.
protocol:
description:
- Protocol.
- The protocol used to communicate with the backend.
choices:
- 'http'
- 'https'
@ -278,8 +288,9 @@ options:
- 'disabled'
request_timeout:
description:
- "Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable va
lues are from 1 second to 86400 seconds."
- Request timeout in seconds.
- Application Gateway will fail the request if response is not received within RequestTimeout.
- Acceptable values are from 1 second to 86400 seconds.
authentication_certificates:
description:
- List of references to application gateway authentication certificates.
@ -298,7 +309,8 @@ options:
- Cookie name to use for the affinity cookie.
path:
description:
- Path which should be used as a prefix for all C(http) requests. Null means no path will be prefixed. Default value is null.
- Path which should be used as a prefix for all C(http) requests.
- Null means no path will be prefixed. Default value is null.
name:
description:
- Name of the resource that is unique within a resource group. This name can be used to access the resource.
@ -314,7 +326,7 @@ options:
- Frontend port resource of an application gateway.
protocol:
description:
- Protocol.
- Protocol of the c(http) listener.
choices:
- 'http'
- 'https'
@ -336,7 +348,7 @@ options:
suboptions:
rule_type:
description:
- Rule I(type).
- Rule type.
choices:
- 'basic'
- 'path_based_routing'
@ -345,7 +357,7 @@ options:
- Backend address pool resource of the application gateway.
backend_http_settings:
description:
- Frontend port resource of the application gateway.
- Backend C(http) settings resource of the application gateway.
http_listener:
description:
- Http listener resource of the application gateway.
@ -354,7 +366,7 @@ options:
- Name of the resource that is unique within a resource group. This name can be used to access the resource.
redirect_configuration:
description:
- Redirect configuration resource of the application gateway
- Redirect configuration resource of the application gateway.
state:
description:
- Assert the state of the Public IP. Use C(present) to create or update a and

15
lib/ansible/modules/cloud/azure/azure_rm_appserviceplan.py
View file

@ -38,10 +38,9 @@ options:
sku:
description:
- The pricing tiers, e.g., F1, D1, B1, B2, B3, S1, P1, P1V2 etc.
- The pricing tiers, e.g., C(F1), C(D1), C(B1), C(B2), C(B3), C(S1), C(P1), C(P1V2) etc.
- Please see U(https://azure.microsoft.com/en-us/pricing/details/app-service/plans/) for more detail.
- For linux app service plan, please see U(https://azure.microsoft.com/en-us/pricing/details/app-service/linux/) for more detail.
- For Linux app service plan, please see U(https://azure.microsoft.com/en-us/pricing/details/app-service/linux/) for more detail.
is_linux:
description:
- Describe whether to host webapp on Linux worker.
@ -54,12 +53,12 @@ options:
state:
description:
- Assert the state of the app service plan.
- Use C(present) to create or update an app service plan and C(absent) to delete it.
- Assert the state of the app service plan.
- Use C(present) to create or update an app service plan and C(absent) to delete it.
default: present
choices:
- absent
- present
- absent
- present
extends_documentation_fragment:
- azure
@ -97,7 +96,7 @@ EXAMPLES = '''
RETURN = '''
azure_appserviceplan:
description: Facts about the current state of the app service plan
description: Facts about the current state of the app service plan.
returned: always
type: dict
sample: {

2
lib/ansible/modules/cloud/azure/azure_rm_appserviceplan_facts.py
View file

@ -19,7 +19,7 @@ module: azure_rm_appserviceplan_facts
version_added: "2.7"
short_description: Get azure app service plan facts.
short_description: Get azure app service plan facts
description:
- Get facts for a specific app service plan or all app service plans in a resource group, or all app service plan in current subscription.

198
lib/ansible/modules/cloud/azure/azure_rm_autoscale.py
View file

@ -17,177 +17,199 @@ DOCUMENTATION = '''
---
module: azure_rm_autoscale
version_added: "2.7"
short_description: Manage Azure autoscale setting.
short_description: Manage Azure autoscale setting
description:
- Create, delete an autoscale setting.
options:
target:
description:
- The identifier of the resource to apply autoscale setting.
- It could be the resource id string.
- It also could be a dict contains the C(name), C(subscription_id), C(namespace), C(types), C(resource_group) of the resource.
- The identifier of the resource to apply autoscale setting.
- It could be the resource id string.
- It also could be a dict contains the C(name), C(subscription_id), C(namespace), C(types), C(resource_group) of the resource.
resource_group:
required: true
description: resource group of the resource.
description:
- Resource group of the resource.
enabled:
type: bool
description: Specifies whether automatic scaling is enabled for the resource.
description:
- Specifies whether automatic scaling is enabled for the resource.
default: true
profiles:
description:
- The collection of automatic scaling profiles that specify different scaling parameters for different time periods.
- A maximum of 20 profiles can be specified.
- The collection of automatic scaling profiles that specify different scaling parameters for different time periods.
- A maximum of 20 profiles can be specified.
suboptions:
name:
required: true
description: the name of the profile.
description:
- The name of the profile.
count:
required: true
description:
- The number of instances that will be set if metrics are not available for evaluation.
- The default is only used if the current instance count is lower than the default.
- The number of instances that will be set if metrics are not available for evaluation.
- The default is only used if the current instance count is lower than the default.
min_count:
description: the minimum number of instances for the resource.
description:
- The minimum number of instances for the resource.
max_count:
description: the maximum number of instances for the resource.
description:
- The maximum number of instances for the resource.
- The actual maximum number of instances is limited by the cores that are available in the subscription.
recurrence_frequency:
default: None
description:
- How often the schedule profile should take effect.
- If this value is Week, meaning each week will have the same set of profiles.
- This element is not used if the FixedDate element is used.
- How often the schedule profile should take effect.
- If this value is C(Week), meaning each week will have the same set of profiles.
- This element is not used if the FixedDate element is used.
choices:
- None
- Second
- Minute
- Hour
- Day
- Week
- Month
- Year
- None
- Second
- Minute
- Hour
- Day
- Week
- Month
- Year
recurrence_timezone:
description:
- The timezone of repeating times at which this profile begins.
- This element is not used if the FixedDate element is used.
- The timezone of repeating times at which this profile begins.
- This element is not used if the FixedDate element is used.
recurrence_days:
description:
- The days of repeating times at which this profile begins.
- This element is not used if the FixedDate element is used.
- The days of repeating times at which this profile begins.
- This element is not used if the FixedDate element is used.
recurrence_hours:
description:
- The hours of repeating times at which this profile begins.
- This element is not used if the FixedDate element is used.
- The hours of repeating times at which this profile begins.
- This element is not used if the FixedDate element is used.
recurrence_mins:
description:
- The mins of repeating times at which this profile begins.
- This element is not used if the FixedDate element is used.
- The mins of repeating times at which this profile begins.
- This element is not used if the FixedDate element is used.
fixed_date_timezone:
description:
- The specific date-time timezone for the profile.
- This element is not used if the Recurrence element is used.
- The specific date-time timezone for the profile.
- This element is not used if the Recurrence element is used.
fixed_date_start:
description:
- The specific date-time start for the profile.
- This element is not used if the Recurrence element is used.
- The specific date-time start for the profile.
- This element is not used if the Recurrence element is used.
fixed_date_end:
description:
- The specific date-time end for the profile.
- This element is not used if the Recurrence element is used.
- The specific date-time end for the profile.
- This element is not used if the Recurrence element is used.
rules:
description:
- The collection of rules that provide the triggers and parameters for the scaling action.
- A maximum of 10 rules can be specified.
- The collection of rules that provide the triggers and parameters for the scaling action.
- A maximum of 10 rules can be specified.
suboptions:
time_aggregation:
default: Average
description: How the data that is collected should be combined over time.
description:
- How the data that is collected should be combined over time.
choices:
- Average
- Minimum
- Maximum
- Total
- Count
- Average
- Minimum
- Maximum
- Total
- Count
time_window:
required: true
description:
- The range of time(minutes) in which instance data is collected.
- This value must be greater than the delay in metric collection, which can vary from resource-to-resource.
- Must be between 5 ~ 720.
- The range of time(minutes) in which instance data is collected.
- This value must be greater than the delay in metric collection, which can vary from resource-to-resource.
- Must be between 5 ~ 720.
direction:
description: Whether the scaling action increases or decreases the number of instances.
description:
- Whether the scaling action increases or decreases the number of instances.
choices:
- Increase
- Decrease
- Increase
- Decrease
metric_name:
required: true
description: The name of the metric that defines what the rule monitors.
description:
- The name of the metric that defines what the rule monitors.
metric_resource_uri:
description: The resource identifier of the resource the rule monitors.
description:
- The resource identifier of the resource the rule monitors.
value:
description:
- The number of instances that are involved in the scaling action.
- This value must be 1 or greater.
- The number of instances that are involved in the scaling action.
- This value must be 1 or greater.
operator:
default: GreaterThan
description: The operator that is used to compare the metric data and the threshold.
description:
- The operator that is used to compare the metric data and the threshold.
choices:
- Equals
- NotEquals
- GreaterThan
- GreaterThanOrEqual
- LessThan
- LessThanOrEqual
- Equals
- NotEquals
- GreaterThan
- GreaterThanOrEqual
- LessThan
- LessThanOrEqual
cooldown:
description:
- The amount of time (minutes) to wait since the last scaling action before this action occurs.
- It must be between 1 ~ 10080.
- The amount of time (minutes) to wait since the last scaling action before this action occurs.
- It must be between 1 ~ 10080.
time_grain:
required: true
description:
- The granularity(minutes) of metrics the rule monitors.
- Must be one of the predefined values returned from metric definitions for the metric.
- Must be between 1 ~ 720.
- The granularity(minutes) of metrics the rule monitors.
- Must be one of the predefined values returned from metric definitions for the metric.
- Must be between 1 ~ 720.
statistic:
default: Average
description: How the metrics from multiple instances are combined.
description:
- How the metrics from multiple instances are combined.
choices:
- Average
- Min
- Max
- Sum
- Average
- Min
- Max
- Sum
threshold:
default: 70
description: The threshold of the metric that triggers the scale action.
description:
- The threshold of the metric that triggers the scale action.
type:
description: The type of action that should occur when the scale rule fires.
description:
- The type of action that should occur when the scale rule fires.
choices:
- PercentChangeCount
- ExactCount
- ChangeCount
- PercentChangeCount
- ExactCount
- ChangeCount
notifications:
description: the collection of notifications.
description:
- The collection of notifications.
suboptions:
custom_emails:
description: the custom e-mails list. This value can be null or empty, in which case this attribute will be ignored.
description:
- The custom e-mails list. This value can be null or empty, in which case this attribute will be ignored.
send_to_subscription_administrator:
type: bool
description: A value indicating whether to send email to subscription administrator.
description:
- A value indicating whether to send email to subscription administrator.
webhooks:
description: The list of webhook notifications service uri.
description:
- The list of webhook notifications service uri.
send_to_subscription_co_administrators:
type: bool
description: A value indicating whether to send email to subscription co-administrators.
description:
- A value indicating whether to send email to subscription co-administrators.
state:
default: present
description: Assert the state of the virtual network. Use C(present) to create or update and C(absent) to delete.
description:
- Assert the state of the virtual network. Use C(present) to create or update and C(absent) to delete.
choices:
- present
- absent
- present
- absent
location:
description: location of the resource.
description:
- location of the resource.
name:
required: true
description: name of the resource.
description:
- name of the resource.
extends_documentation_fragment:

2
lib/ansible/modules/cloud/azure/azure_rm_autoscale_facts.py
View file

@ -17,7 +17,7 @@ DOCUMENTATION = '''
---
module: azure_rm_autoscale_facts
version_added: "2.7"
short_description: Get Azure Auto Scale Setting facts.
short_description: Get Azure Auto Scale Setting facts
description:
- Get facts of Auto Scale Setting.

2
lib/ansible/modules/cloud/google/_gcp_target_proxy.py
View file

@ -29,7 +29,7 @@ requirements:
deprecated:
removed_in: "2.12"
why: Updated modules released with increased functionality
alternative: Use M(gcp_compute_target_proxy) instead.
alternative: Use M(gcp_compute_target_http_proxy) instead.
notes:
- Currently only supports global HTTP proxy.
author:

10
lib/ansible/modules/cloud/ovirt/ovirt_vnic_profile.py
View file

@ -78,14 +78,14 @@ EXAMPLES = '''
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
- name: Add vNIC
ovirt_vnics_profile:
ovirt_vnic_profile:
name: myvnic
network: mynetwork
state: present
data_center: datacenter
- name: Editing vNICs network_filter, custom_properties, qos
ovirt_vnics_profile:
ovirt_vnic_profile:
name: myvnic
network: mynetwork
data_center: datacenter
@ -96,7 +96,7 @@ EXAMPLES = '''
network_filter: allow-dhcp
- name: Editing vNICs network_filter, custom_properties, qos
ovirt_vnics_profile:
ovirt_vnic_profile:
name: myvnic
network: mynetwork
data_center: datacenter
@ -107,7 +107,7 @@ EXAMPLES = '''
network_filter: allow-dhcp
- name: Dont use migratable
ovirt_vnics_profile:
ovirt_vnic_profile:
name: myvnic
network: mynetwork
data_center: datacenter
@ -115,7 +115,7 @@ EXAMPLES = '''
pass_through: enabled
- name: Remove vNIC
ovirt_vnics_profile:
ovirt_vnic_profile:
name: myvnic
network: mynetwork
state: absent

4
lib/ansible/modules/commands/command.py
View file

@ -36,6 +36,7 @@ options:
- See the examples on how to use this module.
required: yes
argv:
type: list
description:
- Passes the command as a list rather than a string.
- Use C(argv) to avoid quoting values that would otherwise be interpreted incorrectly (for example "user name").
@ -43,13 +44,16 @@ options:
provided, not both. One or the other must be provided.
version_added: "2.6"
creates:
type: path
description:
- A filename or (since 2.0) glob pattern. If it already exists, this step B(won't) be run.
removes:
type: path
description:
- A filename or (since 2.0) glob pattern. If it already exists, this step B(will) be run.
version_added: "0.8"
chdir:
type: path
description:
- Change into this directory before running the command.
version_added: "0.6"

5
lib/ansible/modules/commands/expect.py
View file

@ -29,21 +29,26 @@ options:
- The command module takes command to run.
required: true
creates:
type: path
description:
- A filename, when it already exists, this step will B(not) be run.
removes:
type: path
description:
- A filename, when it does not exist, this step will B(not) be run.
chdir:
type: path
description:
- Change into this directory before running the command.
responses:
type: dict
description:
- Mapping of expected string/regex and string to respond with. If the
response is a list, successive matches return successive
responses. List functionality is new in 2.1.
required: true
timeout:
type: int
description:
- Amount of time in seconds to wait for the expected strings. Use
C(null) to disable timeout.

2
lib/ansible/modules/system/group.py
View file

@ -48,7 +48,7 @@ options:
description:
- Forces the use of "local" command alternatives on platforms that implement it.
- This is useful in environments that use centralized authentication when you want to manipulate the local groups.
(e.g. it uses C(lgroupadd) instead of C(useradd)).
(e.g. it uses C(lgroupadd) instead of C(groupadd)).
- This requires that these commands exist on the targeted host, otherwise it will be a fatal error.
type: bool
default: no