summaryrefslogtreecommitdiffstats
path: root/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_datastore_info_module.rst
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-06-05 16:18:34 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-06-05 16:18:34 +0000
commit3667197efb7b18ec842efd504785965911f8ac4b (patch)
tree0b986a4bc6879d080b100666a97cdabbc9ca1f28 /ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_datastore_info_module.rst
parentAdding upstream version 9.5.1+dfsg. (diff)
downloadansible-1f02d92b7a8d732f4e9bbdeb50c68dd718d53d00.tar.xz
ansible-1f02d92b7a8d732f4e9bbdeb50c68dd718d53d00.zip
Adding upstream version 10.0.0+dfsg.upstream/10.0.0+dfsg
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_datastore_info_module.rst')
-rw-r--r--ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_datastore_info_module.rst23
1 files changed, 16 insertions, 7 deletions
diff --git a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_datastore_info_module.rst b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_datastore_info_module.rst
index bdc4e6b98..4fa040e6c 100644
--- a/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_datastore_info_module.rst
+++ b/ansible_collections/vmware/vmware_rest/docs/vmware.vmware_rest.vcenter_datastore_info_module.rst
@@ -5,7 +5,7 @@
vmware.vmware_rest.vcenter_datastore_info
*****************************************
-**Retrieves information about the datastore indicated by {@param.name datastore}.**
+**Retrieves information about the datastore indicated by datastore.**
Version added: 0.1.0
@@ -17,7 +17,7 @@ Version added: 0.1.0
Synopsis
--------
-- Retrieves information about the datastore indicated by {@param.name datastore}.
+- Retrieves information about the datastore indicated by datastore.
@@ -25,7 +25,7 @@ Requirements
------------
The below requirements are needed on the host that executes this module.
-- vSphere 7.0.2 or greater
+- vSphere 7.0.3 or greater
- python >= 3.6
- aiohttp
@@ -55,6 +55,8 @@ Parameters
</td>
<td>
<div>Datacenters that must contain the datastore for the datastore to match the filter.</div>
+ <div>If unset or empty, datastores in any datacenter match the filter.</div>
+ <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_datacenter_info</span>.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: filter_datacenters</div>
</td>
</tr>
@@ -70,7 +72,8 @@ Parameters
<td>
</td>
<td>
- <div>Identifier of the datastore for which information should be retrieved. Required with <em>state=[&#x27;get&#x27;]</em></div>
+ <div>Identifier of the datastore for which information should be retrieved.</div>
+ <div>The parameter must be the id of a resource returned by <span class='module'>vmware.vmware_rest.vcenter_datastore_info</span>. Required with <em>state=[&#x27;get&#x27;]</em></div>
</td>
</tr>
<tr>
@@ -87,6 +90,8 @@ Parameters
</td>
<td>
<div>Identifiers of datastores that can match the filter.</div>
+ <div>If unset or empty, datastores with any identifier match the filter.</div>
+ <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_datastore_info</span>.</div>
</td>
</tr>
<tr>
@@ -103,6 +108,8 @@ Parameters
</td>
<td>
<div>Folders that must contain the datastore for the datastore to match the filter.</div>
+ <div>If unset or empty, datastores in any folder match the filter.</div>
+ <div>When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by <span class='module'>vmware.vmware_rest.vcenter_folder_info</span>.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: filter_folders</div>
</td>
</tr>
@@ -119,7 +126,8 @@ Parameters
<td>
</td>
<td>
- <div>Names that datastores must have to match the filter (see {@link Info#name}).</div>
+ <div>Names that datastores must have to match the filter (see <em>name</em>).</div>
+ <div>If unset or empty, datastores with any name match the filter.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: filter_names</div>
</td>
</tr>
@@ -154,7 +162,8 @@ Parameters
<td>
</td>
<td>
- <div>Types that datastores must have to match the filter (see {@link Summary#type}).</div>
+ <div>Types that datastores must have to match the filter (see <em>type</em>).</div>
+ <div>If unset or empty, datastores with any type match the filter.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: filter_types</div>
</td>
</tr>
@@ -256,7 +265,7 @@ Notes
-----
.. note::
- - Tested on vSphere 7.0.2
+ - Tested on vSphere 7.0.3