community.vmware.vmware_datastore (4.2.0) — module

Install collection

Install with ansible-galaxy collection install community.vmware:==4.2.0

Add to requirements.yml

  collections:
    - name: community.vmware
      version: 4.2.0

Description

Configure Storage I/O Control Settings of a Datastore.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
name:
    description: Name of the datastore.
    required: true
    type: str

port:
    default: 443
    description:
    - The port number of the vSphere vCenter or ESXi server.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_PORT)
      will be used instead.
    type: int

hostname:
    description:
    - 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 E(VMWARE_HOST)
      will be used instead.
    type: str

password:
    aliases:
    - pass
    - pwd
    description:
    - The password of the vSphere vCenter or ESXi server.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_PASSWORD)
      will be used instead.
    type: str

username:
    aliases:
    - admin
    - user
    description:
    - The username of the vSphere vCenter or ESXi server.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_USER)
      will be used instead.
    type: str

datacenter:
    aliases:
    - datacenter_name
    description:
    - Datacenter to search for the datastores.
    type: str

proxy_host:
    description:
    - 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 E(VMWARE_PROXY_HOST)
      will be used instead.
    required: false
    type: str

proxy_port:
    description:
    - 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 E(VMWARE_PROXY_PORT)
      will be used instead.
    required: false
    type: int

validate_certs:
    default: true
    description:
    - Allows connection when SSL certificates are not valid. Set to V(false) when certificates
      are not trusted.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_VALIDATE_CERTS)
      will be used instead.
    type: bool

storage_io_control:
    choices:
    - enable_io_statistics
    - enable_statistics
    - disable
    description:
    - Specify datastore typ.
    required: true
    type: str

statistic_collection:
    default: true
    description:
    - Include I/O statistics for SDRS.
    - Only valid when O(storage_io_control=enable_io_statistics) or O(storage_io_control=enable_statistics).
    type: bool

congestion_threshold_manual:
    description:
    - Storage I/O congestion threshold in ms.
    - Only use O(congestion_threshold_percentage) or O(congestion_threshold_manual).
    - Only valid when O(storage_io_control=enable_io_statistics).
    type: int

congestion_threshold_percentage:
    default: 90
    description:
    - Storage I/O congestion threshold in percentage of peak throughput.
    - A value between 50% and 100%.
    - 'Recommended: 90%'
    - Only use O(congestion_threshold_percentage) or O(congestion_threshold_manual).
    - Only valid when O(storage_io_control=enable_io_statistics).
    type: int

Outputs

result:
  description: Information about datastore operation.
  returned: always
  sample: Datastore configured successfully.
  type: str