|
| 1 | +.. _community.vmware.vmware_vasa_info_module: |
| 2 | + |
| 3 | + |
| 4 | +********************************* |
| 5 | +community.vmware.vmware_vasa_info |
| 6 | +********************************* |
| 7 | + |
| 8 | +**Gather information about vSphere VASA providers.** |
| 9 | + |
| 10 | + |
| 11 | +Version added: 3.8.0 |
| 12 | + |
| 13 | +.. contents:: |
| 14 | + :local: |
| 15 | + :depth: 1 |
| 16 | + |
| 17 | + |
| 18 | +Synopsis |
| 19 | +-------- |
| 20 | +- Returns basic information on the vSphere VASA providers registered in the vcenter. |
| 21 | + |
| 22 | + |
| 23 | + |
| 24 | + |
| 25 | +Parameters |
| 26 | +---------- |
| 27 | + |
| 28 | +.. raw:: html |
| 29 | + |
| 30 | + <table border=0 cellpadding=0 class="documentation-table"> |
| 31 | + <tr> |
| 32 | + <th colspan="1">Parameter</th> |
| 33 | + <th>Choices/<font color="blue">Defaults</font></th> |
| 34 | + <th width="100%">Comments</th> |
| 35 | + </tr> |
| 36 | + <tr> |
| 37 | + <td colspan="1"> |
| 38 | + <div class="ansibleOptionAnchor" id="parameter-"></div> |
| 39 | + <b>hostname</b> |
| 40 | + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> |
| 41 | + <div style="font-size: small"> |
| 42 | + <span style="color: purple">string</span> |
| 43 | + </div> |
| 44 | + </td> |
| 45 | + <td> |
| 46 | + </td> |
| 47 | + <td> |
| 48 | + <div>The hostname or IP address of the vSphere vCenter or ESXi server.</div> |
| 49 | + <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_HOST</code> will be used instead.</div> |
| 50 | + <div>Environment variable support added in Ansible 2.6.</div> |
| 51 | + </td> |
| 52 | + </tr> |
| 53 | + <tr> |
| 54 | + <td colspan="1"> |
| 55 | + <div class="ansibleOptionAnchor" id="parameter-"></div> |
| 56 | + <b>password</b> |
| 57 | + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> |
| 58 | + <div style="font-size: small"> |
| 59 | + <span style="color: purple">string</span> |
| 60 | + </div> |
| 61 | + </td> |
| 62 | + <td> |
| 63 | + </td> |
| 64 | + <td> |
| 65 | + <div>The password of the vSphere vCenter or ESXi server.</div> |
| 66 | + <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_PASSWORD</code> will be used instead.</div> |
| 67 | + <div>Environment variable support added in Ansible 2.6.</div> |
| 68 | + <div style="font-size: small; color: darkgreen"><br/>aliases: pass, pwd</div> |
| 69 | + </td> |
| 70 | + </tr> |
| 71 | + <tr> |
| 72 | + <td colspan="1"> |
| 73 | + <div class="ansibleOptionAnchor" id="parameter-"></div> |
| 74 | + <b>port</b> |
| 75 | + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> |
| 76 | + <div style="font-size: small"> |
| 77 | + <span style="color: purple">integer</span> |
| 78 | + </div> |
| 79 | + </td> |
| 80 | + <td> |
| 81 | + <b>Default:</b><br/><div style="color: blue">443</div> |
| 82 | + </td> |
| 83 | + <td> |
| 84 | + <div>The port number of the vSphere vCenter or ESXi server.</div> |
| 85 | + <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_PORT</code> will be used instead.</div> |
| 86 | + <div>Environment variable support added in Ansible 2.6.</div> |
| 87 | + </td> |
| 88 | + </tr> |
| 89 | + <tr> |
| 90 | + <td colspan="1"> |
| 91 | + <div class="ansibleOptionAnchor" id="parameter-"></div> |
| 92 | + <b>proxy_host</b> |
| 93 | + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> |
| 94 | + <div style="font-size: small"> |
| 95 | + <span style="color: purple">string</span> |
| 96 | + </div> |
| 97 | + </td> |
| 98 | + <td> |
| 99 | + </td> |
| 100 | + <td> |
| 101 | + <div>Address of a proxy that will receive all HTTPS requests and relay them.</div> |
| 102 | + <div>The format is a hostname or a IP.</div> |
| 103 | + <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> |
| 104 | + <div>This feature depends on a version of pyvmomi greater than v6.7.1.2018.12</div> |
| 105 | + </td> |
| 106 | + </tr> |
| 107 | + <tr> |
| 108 | + <td colspan="1"> |
| 109 | + <div class="ansibleOptionAnchor" id="parameter-"></div> |
| 110 | + <b>proxy_port</b> |
| 111 | + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> |
| 112 | + <div style="font-size: small"> |
| 113 | + <span style="color: purple">integer</span> |
| 114 | + </div> |
| 115 | + </td> |
| 116 | + <td> |
| 117 | + </td> |
| 118 | + <td> |
| 119 | + <div>Port of the HTTP proxy that will receive all HTTPS requests and relay them.</div> |
| 120 | + <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> |
| 121 | + </td> |
| 122 | + </tr> |
| 123 | + <tr> |
| 124 | + <td colspan="1"> |
| 125 | + <div class="ansibleOptionAnchor" id="parameter-"></div> |
| 126 | + <b>username</b> |
| 127 | + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> |
| 128 | + <div style="font-size: small"> |
| 129 | + <span style="color: purple">string</span> |
| 130 | + </div> |
| 131 | + </td> |
| 132 | + <td> |
| 133 | + </td> |
| 134 | + <td> |
| 135 | + <div>The username of the vSphere vCenter or ESXi server.</div> |
| 136 | + <div>If the value is not specified in the task, the value of environment variable <code>VMWARE_USER</code> will be used instead.</div> |
| 137 | + <div>Environment variable support added in Ansible 2.6.</div> |
| 138 | + <div style="font-size: small; color: darkgreen"><br/>aliases: admin, user</div> |
| 139 | + </td> |
| 140 | + </tr> |
| 141 | + <tr> |
| 142 | + <td colspan="1"> |
| 143 | + <div class="ansibleOptionAnchor" id="parameter-"></div> |
| 144 | + <b>validate_certs</b> |
| 145 | + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> |
| 146 | + <div style="font-size: small"> |
| 147 | + <span style="color: purple">boolean</span> |
| 148 | + </div> |
| 149 | + </td> |
| 150 | + <td> |
| 151 | + <ul style="margin: 0; padding: 0"><b>Choices:</b> |
| 152 | + <li>no</li> |
| 153 | + <li><div style="color: blue"><b>yes</b> ←</div></li> |
| 154 | + </ul> |
| 155 | + </td> |
| 156 | + <td> |
| 157 | + <div>Allows connection when SSL certificates are not valid. Set to <code>false</code> when certificates are not trusted.</div> |
| 158 | + <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> |
| 159 | + <div>Environment variable support added in Ansible 2.6.</div> |
| 160 | + <div>If set to <code>true</code>, please make sure Python >= 2.7.9 is installed on the given machine.</div> |
| 161 | + </td> |
| 162 | + </tr> |
| 163 | + </table> |
| 164 | + <br/> |
| 165 | + |
| 166 | + |
| 167 | +Notes |
| 168 | +----- |
| 169 | + |
| 170 | +.. note:: |
| 171 | + - All modules requires API write access and hence is not supported on a free ESXi license. |
| 172 | + |
| 173 | + |
| 174 | + |
| 175 | +Examples |
| 176 | +-------- |
| 177 | + |
| 178 | +.. code-block:: yaml |
| 179 | +
|
| 180 | + - name: Get VASA providers info |
| 181 | + community.vmware.vmware_vasa_info: |
| 182 | + hostname: '{{ vcenter_hostname }}' |
| 183 | + username: '{{ vcenter_username }}' |
| 184 | + password: '{{ vcenter_password }}' |
| 185 | + delegate_to: localhost |
| 186 | + register: providers |
| 187 | +
|
| 188 | +
|
| 189 | +
|
| 190 | +Return Values |
| 191 | +------------- |
| 192 | +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: |
| 193 | + |
| 194 | +.. raw:: html |
| 195 | + |
| 196 | + <table border=0 cellpadding=0 class="documentation-table"> |
| 197 | + <tr> |
| 198 | + <th colspan="1">Key</th> |
| 199 | + <th>Returned</th> |
| 200 | + <th width="100%">Description</th> |
| 201 | + </tr> |
| 202 | + <tr> |
| 203 | + <td colspan="1"> |
| 204 | + <div class="ansibleOptionAnchor" id="return-"></div> |
| 205 | + <b>vasa_providers</b> |
| 206 | + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> |
| 207 | + <div style="font-size: small"> |
| 208 | + <span style="color: purple">list</span> |
| 209 | + </div> |
| 210 | + </td> |
| 211 | + <td>success</td> |
| 212 | + <td> |
| 213 | + <div>list of dictionary of VASA info</div> |
| 214 | + <br/> |
| 215 | + <div style="font-size: smaller"><b>Sample:</b></div> |
| 216 | + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">[{'certificate_status': 'valid', 'description': 'IOFILTER VASA Provider on host host01.domain.local', 'name': 'IOFILTER Provider host01.domain.local', 'related_storage_array': [{'active': 'True', 'array_id': 'IOFILTERS:616d4715-7de2-7be2-997a-10f920c5fdbe', 'manageable': 'True', 'priority': '1'}], 'status': 'online', 'uid': '02e10bc5-dd77-4ce4-9100-5aee44e7abaa', 'url': 'https://host01.domain.local:9080/version.xml', 'version': '1.0'}]</div> |
| 217 | + </td> |
| 218 | + </tr> |
| 219 | + </table> |
| 220 | + <br/><br/> |
| 221 | + |
| 222 | + |
| 223 | +Status |
| 224 | +------ |
| 225 | + |
| 226 | + |
| 227 | +Authors |
| 228 | +~~~~~~~ |
| 229 | + |
| 230 | +- Eugenio Grosso (@genegr) <eugenio.grosso@purestorage.com> |
0 commit comments