community.vmware.vmware_datastore module – Configure Datastores
Note
This module is part of the community.vmware collection (version 4.8.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.vmware
.
To use it in a playbook, specify: community.vmware.vmware_datastore
.
New in community.vmware 3.0.0
Synopsis
Configure Storage I/O Control Settings of a Datastore.
Parameters
Parameter |
Comments |
---|---|
Storage I/O congestion threshold in ms. Only use Only valid when |
|
Storage I/O congestion threshold in percentage of peak throughput. A value between 50% and 100%. Recommended: 90% Only use Only valid when Default: |
|
Datacenter to search for the datastores. |
|
The hostname or IP address of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
Name of the datastore. |
|
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Default: |
|
Address of a proxy that will receive all HTTPS requests and relay them. The format is a hostname or a IP. If the value is not specified in the task, the value of environment variable |
|
Port of the HTTP proxy that will receive all HTTPS requests and relay them. If the value is not specified in the task, the value of environment variable |
|
Include I/O statistics for SDRS. Only valid when Choices:
|
|
Specify datastore typ. Choices:
|
|
The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Choices:
|
Notes
Note
All modules requires API write access and hence is not supported on a free ESXi license.
All variables and VMware object names are case sensitive.
Examples
- name: Configure Storage I/O Control of an mounted datastore
community.vmware.vmware_datastore_info:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
datacenter_name: '{{ datacenter_name }}'
name: datastore1
storage_io_control: 'enable_io_statistics'
congestion_threshold_manual: 30
statistic_collection: true
delegate_to: localhost
register: info
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Information about datastore operation. Returned: always Sample: |