Skip to content

Commit

Permalink
Use FQCN to M() references (#291)
Browse files Browse the repository at this point in the history
Use FQCN to M() references

Reviewed-by: https://github.com/apps/ansible-zuul
  • Loading branch information
bmillemathias authored Jul 14, 2020
1 parent a85394b commit 8338f38
Show file tree
Hide file tree
Showing 34 changed files with 80 additions and 79 deletions.
2 changes: 1 addition & 1 deletion plugins/connection/vmware_tools.py
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@
- VM path absolute to the connection.
- "vCenter Example: C(Datacenter/vm/Discovered virtual machine/testVM)."
- "ESXi Host Example: C(ha-datacenter/vm/testVM)."
- Must include VM name, appended to 'folder' as would be passed to M(vmware_guest).
- Must include VM name, appended to 'folder' as would be passed to M(community.vmware.vmware_guest).
- Needs to include I(vm) between the Datacenter and the rest of the VM path.
- Datacenter default value for ESXi server is C(ha-datacenter).
- Folder I(vm) is not visible in the vSphere Web Client but necessary for VMware API to work.
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/vcenter_extension_facts.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@
deprecated:
removed_in: '2.13'
removed_at_date: '2021-12-01'
why: Deprecated in favour of M(vcenter_extension_info) module.
alternative: Use M(vcenter_extension_info) instead.
why: Deprecated in favour of M(community.vmware.vcenter_extension_info) module.
alternative: Use M(community.vmware.vcenter_extension_info) instead.
short_description: Gather facts vCenter extensions
description:
- This module can be used to gather facts about vCenter extension.
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/vmware_about_facts.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
deprecated:
removed_in: '2.13'
removed_at_date: '2021-12-01'
why: Deprecated in favour of M(vmware_about_info) module.
alternative: Use M(vmware_about_info) instead.
why: Deprecated in favour of M(community.vmware.vmware_about_info) module.
alternative: Use M(community.vmware.vmware_about_info) instead.
short_description: Provides information about VMware server to which user is connecting to
description:
- This module can be used to gather information about VMware server to which user is trying to connect.
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/vmware_category_facts.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
deprecated:
removed_in: '2.13'
removed_at_date: '2021-12-01'
why: Deprecated in favour of M(vmware_category_info) module.
alternative: Use M(vmware_category_info) instead.
why: Deprecated in favour of M(community.vmware.vmware_category_info) module.
alternative: Use M(community.vmware.vmware_category_info) instead.
short_description: Gather facts about VMware tag categories
description:
- This module can be used to gather facts about VMware tag categories.
Expand Down
38 changes: 19 additions & 19 deletions plugins/modules/vmware_cluster.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,15 +55,15 @@
enable_drs:
description:
- If set to C(yes), will enable DRS when the cluster is created.
- Use C(enable_drs) of M(vmware_cluster_drs) instead.
- Use C(enable_drs) of M(community.vmware.vmware_cluster_drs) instead.
- Deprecated option, will be removed in version 2.12.
type: bool
default: 'no'
drs_enable_vm_behavior_overrides:
description:
- Determines whether DRS Behavior overrides for individual virtual machines are enabled.
- If set to C(True), overrides C(drs_default_vm_behavior).
- Use C(drs_enable_vm_behavior_overrides) of M(vmware_cluster_drs) instead.
- Use C(drs_enable_vm_behavior_overrides) of M(community.vmware.vmware_cluster_drs) instead.
- Deprecated option, will be removed in version 2.12.
type: bool
default: True
Expand All @@ -76,21 +76,21 @@
for the placement with a host. vCenter should not implement the recommendations automatically.
- If set to C(fullyAutomated), then vCenter should automate both the migration of virtual machines
and their placement with a host at power on.
- Use C(drs_default_vm_behavior) of M(vmware_cluster_drs) instead.
- Use C(drs_default_vm_behavior) of M(community.vmware.vmware_cluster_drs) instead.
- Deprecated option, will be removed in version 2.12.
default: fullyAutomated
choices: [ fullyAutomated, manual, partiallyAutomated ]
drs_vmotion_rate:
description:
- Threshold for generated ClusterRecommendations.
- Use C(drs_vmotion_rate) of M(vmware_cluster_drs) instead.
- Use C(drs_vmotion_rate) of M(community.vmware.vmware_cluster_drs) instead.
- Deprecated option, will be removed in version 2.12.
default: 3
choices: [ 1, 2, 3, 4, 5 ]
enable_ha:
description:
- If set to C(yes) will enable HA when the cluster is created.
- Use C(enable_ha) of M(vmware_cluster_ha) instead.
- Use C(enable_ha) of M(community.vmware.vmware_cluster_ha) instead.
- Deprecated option, will be removed in version 2.12.
type: bool
default: 'no'
Expand All @@ -100,7 +100,7 @@
- If set to C(enabled), HA restarts virtual machines after a host fails.
- If set to C(disabled), HA does not restart virtual machines after a host fails.
- If C(enable_ha) is set to C(no), then this value is ignored.
- Use C(ha_host_monitoring) of M(vmware_cluster_ha) instead.
- Use C(ha_host_monitoring) of M(community.vmware.vmware_cluster_ha) instead.
- Deprecated option, will be removed in version 2.12.
choices: [ 'enabled', 'disabled' ]
default: 'enabled'
Expand All @@ -111,7 +111,7 @@
- If set to C(vmMonitoringDisabled), virtual machine health monitoring is disabled.
- If set to C(vmMonitoringOnly), HA response to virtual machine heartbeat failure.
- If C(enable_ha) is set to C(no), then this value is ignored.
- Use C(ha_vm_monitoring) of M(vmware_cluster_ha) instead.
- Use C(ha_vm_monitoring) of M(community.vmware.vmware_cluster_ha) instead.
- Deprecated option, will be removed in version 2.12.
choices: ['vmAndAppMonitoring', 'vmMonitoringOnly', 'vmMonitoringDisabled']
default: 'vmMonitoringDisabled'
Expand All @@ -120,14 +120,14 @@
- Number of host failures that should be tolerated, still guaranteeing sufficient resources to
restart virtual machines on available hosts.
- Accepts integer values only.
- Use C(slot_based_admission_control), C(reservation_based_admission_control) or C(failover_host_admission_control) of M(vmware_cluster_ha) instead.
- Use C(slot_based_admission_control), C(reservation_based_admission_control) or C(failover_host_admission_control) of M(community.vmware.vmware_cluster_ha) instead.
- Deprecated option, will be removed in version 2.12.
default: 2
ha_admission_control_enabled:
description:
- Determines if strict admission control is enabled.
- It is recommended to set this parameter to C(True), please refer documentation for more details.
- Use C(slot_based_admission_control), C(reservation_based_admission_control) or C(failover_host_admission_control) of M(vmware_cluster_ha) instead.
- Use C(slot_based_admission_control), C(reservation_based_admission_control) or C(failover_host_admission_control) of M(community.vmware.vmware_cluster_ha) instead.
- Deprecated option, will be removed in version 2.12.
default: True
type: bool
Expand All @@ -137,7 +137,7 @@
if no heartbeat has been received.
- This setting is only valid if C(ha_vm_monitoring) is set to, either C(vmAndAppMonitoring) or C(vmMonitoringOnly).
- Unit is seconds.
- Use C(ha_vm_failure_interval) of M(vmware_cluster_ha) instead.
- Use C(ha_vm_failure_interval) of M(community.vmware.vmware_cluster_ha) instead.
- Deprecated option, will be removed in version 2.12.
default: 30
ha_vm_min_up_time:
Expand All @@ -146,15 +146,15 @@
the virtual machine has been powered on.
- This setting is only valid if C(ha_vm_monitoring) is set to, either C(vmAndAppMonitoring) or C(vmMonitoringOnly).
- Unit is seconds.
- Use C(ha_vm_min_up_time) of M(vmware_cluster_ha) instead.
- Use C(ha_vm_min_up_time) of M(community.vmware.vmware_cluster_ha) instead.
- Deprecated option, will be removed in version 2.12.
default: 120
ha_vm_max_failures:
description:
- Maximum number of failures and automated resets allowed during the time
that C(ha_vm_max_failure_window) specifies.
- This setting is only valid if C(ha_vm_monitoring) is set to, either C(vmAndAppMonitoring) or C(vmMonitoringOnly).
- Use C(ha_vm_max_failures) of M(vmware_cluster_ha) instead.
- Use C(ha_vm_max_failures) of M(community.vmware.vmware_cluster_ha) instead.
- Deprecated option, will be removed in version 2.12.
default: 3
ha_vm_max_failure_window:
Expand All @@ -164,7 +164,7 @@
- This setting is only valid if C(ha_vm_monitoring) is set to, either C(vmAndAppMonitoring) or C(vmMonitoringOnly).
- Unit is seconds.
- Default specifies no failure window.
- Use C(ha_vm_max_failure_window) of M(vmware_cluster_ha) instead.
- Use C(ha_vm_max_failure_window) of M(community.vmware.vmware_cluster_ha) instead.
- Deprecated option, will be removed in version 2.12.
default: -1
ha_restart_priority:
Expand All @@ -179,22 +179,22 @@
when there is insufficient capacity on hosts to meet all virtual machine needs.
- If set to C(low), then virtual machine with this priority have a lower chance of powering on after a failure,
when there is insufficient capacity on hosts to meet all virtual machine needs.
- Use C(ha_restart_priority) of M(vmware_cluster_ha) instead.
- Use C(ha_restart_priority) of M(community.vmware.vmware_cluster_ha) instead.
- Deprecated option, will be removed in version 2.12.
default: 'medium'
choices: [ 'disabled', 'high', 'low', 'medium' ]
enable_vsan:
description:
- If set to C(yes) will enable vSAN when the cluster is created.
- Use C(enable_vsan) of M(vmware_cluster_vsan) instead.
- Use C(enable_vsan) of M(community.vmware.vmware_cluster_vsan) instead.
- Deprecated option, will be removed in version 2.12.
type: bool
default: 'no'
vsan_auto_claim_storage:
description:
- Determines whether the VSAN service is configured to automatically claim local storage
on VSAN-enabled hosts in the cluster.
- Use C(vsan_auto_claim_storage) of M(vmware_cluster_vsan) instead.
- Use C(vsan_auto_claim_storage) of M(community.vmware.vmware_cluster_vsan) instead.
- Deprecated option, will be removed in version 2.12.
type: bool
default: False
Expand All @@ -204,9 +204,9 @@
choices: [ absent, present ]
default: present
seealso:
- module: vmware_cluster_drs
- module: vmware_cluster_ha
- module: vmware_cluster_vsan
- module: community.vmware.vmware_cluster_drs
- module: community.vmware.vmware_cluster_ha
- module: community.vmware.vmware_cluster_vsan
extends_documentation_fragment:
- community.vmware.vmware.documentation
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/vmware_drs_group_facts.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@
deprecated:
removed_in: '2.13'
removed_at_date: '2021-12-01'
why: Deprecated in favour of M(vmware_drs_group_info) module.
alternative: Use M(vmware_drs_group_info) instead.
why: Deprecated in favour of M(community.vmware.vmware_drs_group_info) module.
alternative: Use M(community.vmware.vmware_drs_group_info) instead.
author:
- "Karsten Kaj Jakobsen (@karstenjakobsen)"
description:
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/vmware_drs_rule_facts.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
deprecated:
removed_in: '2.13'
removed_at_date: '2021-12-01'
why: Deprecated in favour of M(vmware_drs_rule_info) module.
alternative: Use M(vmware_drs_rule_info) instead.
why: Deprecated in favour of M(community.vmware.vmware_drs_rule_info) module.
alternative: Use M(community.vmware.vmware_drs_rule_info) instead.
short_description: Gathers facts about DRS rule on the given cluster
description:
- 'This module can be used to gather facts about DRS VM-VM and VM-HOST rules from the given cluster.'
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/vmware_dvs_portgroup_facts.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
deprecated:
removed_in: '2.13'
removed_at_date: '2021-12-01'
why: Deprecated in favour of M(vmware_dvs_portgroup_info) module.
alternative: Use M(vmware_dvs_portgroup_info) instead.
why: Deprecated in favour of M(community.vmware.vmware_dvs_portgroup_info) module.
alternative: Use M(community.vmware.vmware_dvs_portgroup_info) instead.
short_description: Gathers facts DVS portgroup configurations
description:
- This module can be used to gather facts about DVS portgroup configurations.
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/vmware_guest.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
- python >= 2.6
- PyVmomi
notes:
- Please make sure that the user used for M(vmware_guest) has the correct level of privileges.
- Please make sure that the user used for M(community.vmware.vmware_guest) has the correct level of privileges.
- For example, following is the list of minimum privileges required by users to create virtual machines.
- " DataStore > Allocate Space"
- " Virtual Machine > Configuration > Add New Disk"
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/vmware_guest_boot_facts.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
deprecated:
removed_in: '2.13'
removed_at_date: '2021-12-01'
why: Deprecated in favour of M(vmware_guest_boot_info) module.
alternative: Use M(vmware_guest_boot_info) instead.
why: Deprecated in favour of M(community.vmware.vmware_guest_boot_info) module.
alternative: Use M(community.vmware.vmware_guest_boot_info) instead.
short_description: Gather facts about boot options for the given virtual machine
description:
- Gather facts about boot options for the given virtual machine.
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/vmware_guest_customization_facts.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
deprecated:
removed_in: '2.13'
removed_at_date: '2021-12-01'
why: Deprecated in favour of M(vmware_guest_customization_info) module.
alternative: Use M(vmware_guest_customization_info) instead.
why: Deprecated in favour of M(community.vmware.vmware_guest_customization_info) module.
alternative: Use M(community.vmware.vmware_guest_customization_info) instead.
short_description: Gather facts about VM customization specifications
description:
- This module can be used to gather facts about customization specifications.
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/vmware_guest_disk_facts.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
deprecated:
removed_in: '2.13'
removed_at_date: '2021-12-01'
why: Deprecated in favour of M(vmware_guest_disk_info) module.
alternative: Use M(vmware_guest_disk_info) instead.
why: Deprecated in favour of M(community.vmware.vmware_guest_disk_info) module.
alternative: Use M(community.vmware.vmware_guest_disk_info) instead.
short_description: Gather facts about disks of given virtual machine
description:
- This module can be used to gather facts about disks belonging to given virtual machine.
Expand Down
3 changes: 2 additions & 1 deletion plugins/modules/vmware_guest_tools_upgrade.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@
- "python >= 2.6"
- PyVmomi
notes:
- "In order to upgrade VMTools, please power on virtual machine before hand - either 'manually' or using module M(vmware_guest_powerstate)."
- "In order to upgrade VMTools, please power on virtual machine before hand - either 'manually' or
using module M(community.vmware.vmware_guest_powerstate)."
options:
name:
description:
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/vmware_host_capability_facts.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@
deprecated:
removed_in: '2.13'
removed_at_date: "2021-12-01"
why: Deprecated in favour of M(vmware_host_capability_info) module.
alternative: Use M(vmware_host_capability_info) instead.
why: Deprecated in favour of M(community.vmware.vmware_host_capability_info) module.
alternative: Use M(community.vmware.vmware_host_capability_info) instead.
short_description: Gathers facts about an ESXi host's capability information
description:
- This module can be used to gather facts about an ESXi host's capability information when ESXi hostname or Cluster name is given.
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/vmware_host_config_facts.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@
deprecated:
removed_in: '2.13'
removed_at_date: '2021-12-01'
why: Deprecated in favour of M(vmware_host_config_info) module.
alternative: Use M(vmware_host_config_info) instead.
why: Deprecated in favour of M(community.vmware.vmware_host_config_info) module.
alternative: Use M(community.vmware.vmware_host_config_info) instead.
short_description: Gathers facts about an ESXi host's advance configuration information
description:
- This module can be used to gather facts about an ESXi host's advance configuration information when ESXi hostname or Cluster name is given.
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/vmware_host_dns_facts.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
deprecated:
removed_in: '2.13'
removed_at_date: '2021-12-01'
why: Deprecated in favour of M(vmware_host_dns_info) module.
alternative: Use M(vmware_host_dns_info) instead.
why: Deprecated in favour of M(community.vmware.vmware_host_dns_info) module.
alternative: Use M(community.vmware.vmware_host_dns_info) instead.
short_description: Gathers facts about an ESXi host's DNS configuration information
description:
- This module can be used to gather facts about an ESXi host's DNS configuration information when ESXi hostname or Cluster name is given.
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/vmware_host_feature_facts.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@
deprecated:
removed_in: '2.13'
removed_at_date: '2021-12-01'
why: Deprecated in favour of M(vmware_host_feature_info) module.
alternative: Use M(vmware_host_feature_info) instead.
why: Deprecated in favour of M(community.vmware.vmware_host_feature_info) module.
alternative: Use M(community.vmware.vmware_host_feature_info) instead.
short_description: Gathers facts about an ESXi host's feature capability information
description:
- This module can be used to gather facts about an ESXi host's feature capability information when ESXi hostname or Cluster name is given.
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/vmware_host_firewall_facts.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@
deprecated:
removed_in: '2.13'
removed_at_date: '2021-12-01'
why: Deprecated in favour of M(vmware_host_firewall_info) module.
alternative: Use M(vmware_host_firewall_info) instead.
why: Deprecated in favour of M(community.vmware.vmware_host_firewall_info) module.
alternative: Use M(community.vmware.vmware_host_firewall_info) instead.
short_description: Gathers facts about an ESXi host's firewall configuration information
description:
- This module can be used to gather facts about an ESXi host's firewall configuration information when ESXi hostname or Cluster name is given.
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/vmware_host_kernel_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
- All connected ESXi hosts in scope will be configured when specified.
- If a host is not connected at time of configuration, it will be marked as such in the output.
- Kernel module options may require a reboot to take effect which is not covered here.
- You can use M(reboot) or M(vmware_host_powerstate) module to reboot all ESXi host systems.
- You can use M(community.vmware.reboot) or M(community.vmware.vmware_host_powerstate) module to reboot all ESXi host systems.
author:
- Aaron Longchamps (@alongchamps)
notes:
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/vmware_host_logbundle.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
manifests:
description:
- Logs to include in the logbundle file.
- Refer to the id key of the M(vmware_host_logbundle_info) module for values that can be specified in the manifest.
- Refer to the id key of the M(community.vmware.vmware_host_logbundle_info) module for values that can be specified in the manifest.
default:
- System:Base
- System:CoreDumps
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/vmware_host_ntp_facts.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@
deprecated:
removed_in: '2.13'
removed_at_date: '2021-12-01'
why: Deprecated in favour of M(vmware_host_ntp_info) module.
alternative: Use M(vmware_host_ntp_info) instead.
why: Deprecated in favour of M(community.vmware.vmware_host_ntp_info) module.
alternative: Use M(community.vmware.vmware_host_ntp_info) instead.
short_description: Gathers facts about NTP configuration on an ESXi host
description:
- This module can be used to gather facts about NTP configurations on an ESXi host.
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/vmware_host_package_facts.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@
deprecated:
removed_in: '2.13'
removed_at_date: '2021-12-01'
why: Deprecated in favour of M(vmware_host_package_info) module.
alternative: Use M(vmware_host_package_info) instead.
why: Deprecated in favour of M(community.vmware.vmware_host_package_info) module.
alternative: Use M(community.vmware.vmware_host_package_info) instead.
short_description: Gathers facts about available packages on an ESXi host
description:
- This module can be used to gather facts about available packages and their status on an ESXi host.
Expand Down
Loading

0 comments on commit 8338f38

Please sign in to comment.