forked from ansible-collections/community.vmware
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
prepare 3.7.0 release (ansible-collections#1767)
prepare 3.7.0 release New release 3.7.0! ansible-playbook tools/prepare_release.yml
- Loading branch information
Showing
17 changed files
with
563 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
3 changes: 0 additions & 3 deletions
3
changelogs/fragments/1736-vmware_cluster_drs_recommendations.yaml
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
265 changes: 265 additions & 0 deletions
265
docs/community.vmware.vmware_cluster_drs_recommendations_module.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,265 @@ | ||
| .. _community.vmware.vmware_cluster_drs_recommendations_module: | ||
|
|
||
|
|
||
| *************************************************** | ||
| community.vmware.vmware_cluster_drs_recommendations | ||
| *************************************************** | ||
|
|
||
| **Apply DRS Recommendations** | ||
|
|
||
|
|
||
| Version added: 3.7.0 | ||
|
|
||
| .. contents:: | ||
| :local: | ||
| :depth: 1 | ||
|
|
||
|
|
||
| Synopsis | ||
| -------- | ||
| - Apply DRS Recommendations for Cluster. | ||
|
|
||
|
|
||
|
|
||
|
|
||
| Parameters | ||
| ---------- | ||
|
|
||
| .. raw:: html | ||
|
|
||
| <table border=0 cellpadding=0 class="documentation-table"> | ||
| <tr> | ||
| <th colspan="1">Parameter</th> | ||
| <th>Choices/<font color="blue">Defaults</font></th> | ||
| <th width="100%">Comments</th> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1"> | ||
| <div class="ansibleOptionAnchor" id="parameter-"></div> | ||
| <b>cluster_name</b> | ||
| <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> | ||
| <div style="font-size: small"> | ||
| <span style="color: purple">string</span> | ||
| / <span style="color: red">required</span> | ||
| </div> | ||
| </td> | ||
| <td> | ||
| </td> | ||
| <td> | ||
| <div>The name of the cluster to be managed.</div> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1"> | ||
| <div class="ansibleOptionAnchor" id="parameter-"></div> | ||
| <b>datacenter</b> | ||
| <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> | ||
| <div style="font-size: small"> | ||
| <span style="color: purple">string</span> | ||
| / <span style="color: red">required</span> | ||
| </div> | ||
| </td> | ||
| <td> | ||
| </td> | ||
| <td> | ||
| <div>The name of the datacenter.</div> | ||
| <div style="font-size: small; color: darkgreen"><br/>aliases: datacenter_name</div> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1"> | ||
| <div class="ansibleOptionAnchor" id="parameter-"></div> | ||
| <b>hostname</b> | ||
| <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> | ||
| <div style="font-size: small"> | ||
| <span style="color: purple">string</span> | ||
| </div> | ||
| </td> | ||
| <td> | ||
| </td> | ||
| <td> | ||
| <div>The hostname or IP address of the vSphere vCenter or ESXi server.</div> | ||
| <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_HOST</code> will be used instead.</div> | ||
| <div>Environment variable support added in Ansible 2.6.</div> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1"> | ||
| <div class="ansibleOptionAnchor" id="parameter-"></div> | ||
| <b>password</b> | ||
| <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> | ||
| <div style="font-size: small"> | ||
| <span style="color: purple">string</span> | ||
| </div> | ||
| </td> | ||
| <td> | ||
| </td> | ||
| <td> | ||
| <div>The password of the vSphere vCenter or ESXi server.</div> | ||
| <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_PASSWORD</code> will be used instead.</div> | ||
| <div>Environment variable support added in Ansible 2.6.</div> | ||
| <div style="font-size: small; color: darkgreen"><br/>aliases: pass, pwd</div> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1"> | ||
| <div class="ansibleOptionAnchor" id="parameter-"></div> | ||
| <b>port</b> | ||
| <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> | ||
| <div style="font-size: small"> | ||
| <span style="color: purple">integer</span> | ||
| </div> | ||
| </td> | ||
| <td> | ||
| <b>Default:</b><br/><div style="color: blue">443</div> | ||
| </td> | ||
| <td> | ||
| <div>The port number of the vSphere vCenter or ESXi server.</div> | ||
| <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_PORT</code> will be used instead.</div> | ||
| <div>Environment variable support added in Ansible 2.6.</div> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1"> | ||
| <div class="ansibleOptionAnchor" id="parameter-"></div> | ||
| <b>proxy_host</b> | ||
| <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> | ||
| <div style="font-size: small"> | ||
| <span style="color: purple">string</span> | ||
| </div> | ||
| </td> | ||
| <td> | ||
| </td> | ||
| <td> | ||
| <div>Address of a proxy that will receive all HTTPS requests and relay them.</div> | ||
| <div>The format is a hostname or a IP.</div> | ||
| <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_PROXY_HOST</code> will be used instead.</div> | ||
| <div>This feature depends on a version of pyvmomi greater than v6.7.1.2018.12</div> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1"> | ||
| <div class="ansibleOptionAnchor" id="parameter-"></div> | ||
| <b>proxy_port</b> | ||
| <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> | ||
| <div style="font-size: small"> | ||
| <span style="color: purple">integer</span> | ||
| </div> | ||
| </td> | ||
| <td> | ||
| </td> | ||
| <td> | ||
| <div>Port of the HTTP proxy that will receive all HTTPS requests and relay them.</div> | ||
| <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_PROXY_PORT</code> will be used instead.</div> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1"> | ||
| <div class="ansibleOptionAnchor" id="parameter-"></div> | ||
| <b>username</b> | ||
| <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> | ||
| <div style="font-size: small"> | ||
| <span style="color: purple">string</span> | ||
| </div> | ||
| </td> | ||
| <td> | ||
| </td> | ||
| <td> | ||
| <div>The username of the vSphere vCenter or ESXi server.</div> | ||
| <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_USER</code> will be used instead.</div> | ||
| <div>Environment variable support added in Ansible 2.6.</div> | ||
| <div style="font-size: small; color: darkgreen"><br/>aliases: admin, user</div> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1"> | ||
| <div class="ansibleOptionAnchor" id="parameter-"></div> | ||
| <b>validate_certs</b> | ||
| <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> | ||
| <div style="font-size: small"> | ||
| <span style="color: purple">boolean</span> | ||
| </div> | ||
| </td> | ||
| <td> | ||
| <ul style="margin: 0; padding: 0"><b>Choices:</b> | ||
| <li>no</li> | ||
| <li><div style="color: blue"><b>yes</b> ←</div></li> | ||
| </ul> | ||
| </td> | ||
| <td> | ||
| <div>Allows connection when SSL certificates are not valid. Set to <code>false</code> when certificates are not trusted.</div> | ||
| <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_VALIDATE_CERTS</code> will be used instead.</div> | ||
| <div>Environment variable support added in Ansible 2.6.</div> | ||
| <div>If set to <code>true</code>, please make sure Python >= 2.7.9 is installed on the given machine.</div> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
| <br/> | ||
|
|
||
|
|
||
| Notes | ||
| ----- | ||
|
|
||
| .. note:: | ||
| - All modules requires API write access and hence is not supported on a free ESXi license. | ||
|
|
||
|
|
||
|
|
||
| Examples | ||
| -------- | ||
|
|
||
| .. code-block:: yaml | ||
| - name: Apply DRS Recommendations for Cluster | ||
| community.vmware.vmware_cluster: | ||
| hostname: '{{ vcenter_hostname }}' | ||
| username: '{{ vcenter_username }}' | ||
| password: '{{ vcenter_password }}' | ||
| datacenter_name: datacenter | ||
| cluster_name: cluster | ||
| delegate_to: localhost | ||
| Return Values | ||
| ------------- | ||
| Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module: | ||
|
|
||
| .. raw:: html | ||
|
|
||
| <table border=0 cellpadding=0 class="documentation-table"> | ||
| <tr> | ||
| <th colspan="1">Key</th> | ||
| <th>Returned</th> | ||
| <th width="100%">Description</th> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1"> | ||
| <div class="ansibleOptionAnchor" id="return-"></div> | ||
| <b>result</b> | ||
| <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> | ||
| <div style="font-size: small"> | ||
| <span style="color: purple">list</span> | ||
| </div> | ||
| </td> | ||
| <td>always</td> | ||
| <td> | ||
| <div>list of the recommendations</div> | ||
| <div>What server moved from which host to which host.</div> | ||
| <br/> | ||
| <div style="font-size: smaller"><b>Sample:</b></div> | ||
| <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['server1 move from host1 to host2.', 'server2 move from host1 to host2.']</div> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
| <br/><br/> | ||
|
|
||
|
|
||
| Status | ||
| ------ | ||
|
|
||
|
|
||
| Authors | ||
| ~~~~~~~ | ||
|
|
||
| - Nina Loser (@Nina2244) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.