community.vmware.vmware_target_canonical_info module – Return canonical (NAA) from an ESXi host system
Note
This module is part of the community.vmware collection (version 5.2.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_target_canonical_info.
Synopsis
This module can be used to gather information about canonical (NAA) from an ESXi host based on SCSI target ID.
Parameters
Parameter |
Comments |
|---|---|
Name of the cluster. Info about all SCSI devices for all host system in the given cluster is returned. This parameter is required, if |
|
Name of the ESXi host system. Info about all SCSI devices for the given ESXi host system is returned. This parameter is required, if |
|
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 |
|
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 |
|
The target id based on order of scsi device. version 2.6 onwards, this parameter is optional. |
|
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: Get Canonical name of particular target on particular ESXi host system
community.vmware.vmware_target_canonical_info:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
target_id: 7
esxi_hostname: esxi_hostname
delegate_to: localhost
- name: Get Canonical name of all target on particular ESXi host system
community.vmware.vmware_target_canonical_info:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
esxi_hostname: '{{ esxi_hostname }}'
delegate_to: localhost
- name: Get Canonical name of all ESXi hostname on particular Cluster
community.vmware.vmware_target_canonical_info:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
cluster_name: '{{ cluster_name }}'
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
metadata about SCSI Target device Returned: if host system and target id is given Sample: |
|
metadata about all SCSI Target devices Returned: if host system or cluster is given Sample: |