Rename ali_instance_facts -> ali_instance_info (#57036)

* Rename ali_instance_facts -> ali_instance_info.

* Add changelog.
This commit is contained in:
Felix Fontein 2019-06-10 12:40:50 +02:00 committed by GitHub
parent 9ba3b01ef0
commit ef2d70a806
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 12 additions and 5 deletions

View file

@ -0,0 +1,2 @@
minor_changes:
- The ``ali_instance_facts`` module has been renamed to ``ali_instance_info``.

View file

@ -78,6 +78,7 @@ Noteworthy module changes
* The ``memset_memstore_facts`` module was renamed to :ref:`memset_memstore_info <memset_memstore_info_module>`.
* The ``memset_server_facts`` module was renamed to :ref:`memset_server_info <memset_server_info_module>`.
* The ``one_image_facts`` module was renamed to :ref:`one_image_info <one_image_info_module>`.
* The ``ali_instance_facts`` module was renamed to :ref:`ali_instance_info <ali_instance_info_module>`.
* The ``azure_rm_resourcegroup_facts`` module was renamed to :ref:`azure_rm_resourcegroup_info <azure_rm_resourcegroup_info_module>`.
* The ``digital_ocean_account_facts`` module was renamed to :ref:`digital_ocean_account_info <digital_ocean_account_info_module>`.
* The ``digital_ocean_certificate_facts`` module was renamed to :ref:`digital_ocean_certificate_info <digital_ocean_certificate_info_module>`.

View file

@ -0,0 +1 @@
ali_instance_info.py

View file

@ -26,12 +26,13 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
DOCUMENTATION = '''
---
module: ali_instance_facts
module: ali_instance_info
version_added: "2.8"
short_description: Gather facts on instances of Alibaba Cloud ECS.
short_description: Gather information on instances of Alibaba Cloud ECS.
description:
- This module fetches data from the Open API in Alicloud.
The module must be called from within the ECS instance itself.
- This module was called C(ali_instance_facts) before Ansible 2.9. The usage did not change.
options:
availability_zone:
@ -71,14 +72,14 @@ EXAMPLES = '''
tasks:
- name: Find all instances in the specified region
ali_instance_facts:
ali_instance_info:
alicloud_access_key: '{{ alicloud_access_key }}'
alicloud_secret_key: '{{ alicloud_secret_key }}'
alicloud_region: '{{ alicloud_region }}'
register: all_instances
- name: Find all instances based on the specified ids
ali_instance_facts:
ali_instance_info:
alicloud_access_key: '{{ alicloud_access_key }}'
alicloud_secret_key: '{{ alicloud_secret_key }}'
alicloud_region: '{{ alicloud_region }}'
@ -88,7 +89,7 @@ EXAMPLES = '''
register: instances_by_ids
- name: Find all instances based on the specified names/name-prefixes
ali_instance_facts:
ali_instance_info:
alicloud_access_key: '{{ alicloud_access_key }}'
alicloud_secret_key: '{{ alicloud_secret_key }}'
alicloud_region: '{{ alicloud_region }}'
@ -373,6 +374,8 @@ def main():
)
)
module = AnsibleModule(argument_spec=argument_spec)
if module._name == 'ali_instance_facts':
module.deprecate("The 'ali_instance_facts' module has been renamed to 'ali_instance_info'", version='2.13')
if HAS_FOOTMARK is False:
module.fail_json(msg=missing_required_lib('footmark'), exception=FOOTMARK_IMP_ERR)