community / community.vmware / 4.2.0 / module / vmware_datastore_maintenancemode Place a datastore into maintenance mode Authors: Abhijeet Kasurde (@Akasurde)community.vmware.vmware_datastore_maintenancemode (4.2.0) — module
Install with ansible-galaxy collection install community.vmware:==4.2.0
collections: - name: community.vmware version: 4.2.0
This module can be used to manage maintenance mode of a datastore.
- name: Enter datastore into Maintenance Mode community.vmware.vmware_datastore_maintenancemode: hostname: '{{ vcenter_hostname }}' username: '{{ vcenter_username }}' password: '{{ vcenter_password }}' datastore: '{{ datastore_name }}' state: present delegate_to: localhost
- name: Enter all datastores under cluster into Maintenance Mode community.vmware.vmware_datastore_maintenancemode: hostname: '{{ vcenter_hostname }}' username: '{{ vcenter_username }}' password: '{{ vcenter_password }}' cluster_name: '{{ cluster_name }}' state: present delegate_to: localhost
- name: Enter all datastores under datastore cluster into Maintenance Mode community.vmware.vmware_datastore_maintenancemode: hostname: '{{ vcenter_hostname }}' username: '{{ vcenter_username }}' password: '{{ vcenter_password }}' datastore_cluster: '{{ datastore_cluster_name }}' state: present delegate_to: localhost
- name: Exit datastore into Maintenance Mode community.vmware.vmware_datastore_maintenancemode: hostname: '{{ vcenter_hostname }}' username: '{{ vcenter_username }}' password: '{{ vcenter_password }}' datastore: '{{ datastore_name }}' state: absent delegate_to: localhost
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 state: choices: - present - absent default: present description: - If set to V(present), then enter datastore into maintenance mode. - If set to V(present) and datastore is already in maintenance mode, then no action will be taken. - If set to V(absent) and datastore is in maintenance mode, then exit maintenance mode. - If set to V(absent) and datastore is not in maintenance mode, then no action will be taken. required: false type: str 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 datastore: description: - Name of datastore to manage. - If O(datastore_cluster) or O(cluster_name) are not set, this parameter is required. 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 cluster_name: description: - Name of the cluster where datastore is connected to. - If multiple datastores are connected to the given cluster, then all datastores will be managed by O(state). - If O(datastore) or O(datastore_cluster) are not set, this parameter is required. type: str 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 datastore_cluster: description: - Name of the datastore cluster from all child datastores to be managed. - If O(datastore) or O(cluster_name) are not set, this parameter is required. type: str
datastore_status: description: Action taken for datastore returned: always sample: ds_226_01: Datastore 'ds_226_01' is already in maintenance mode. type: dict