vmware_target_canonical_facts - Return canonical (NAA) from an ESXi host system¶

New in version 2.0.

Synopsis
- Requirements
Parameters
Examples
Return Values
Status
Maintenance
- Author

Synopsis ¶

This module can be used to gather facts about canonical (NAA) from an ESXi host based on SCSI target ID.

Requirements ¶

The below requirements are needed on the host that executes this module.

Tested on vSphere 5.5 and 6.5
PyVmomi installed

Parameters ¶

Parameter	Choices/Defaults	Comments
cluster_name (added in 2.6)		Name of the cluster. Facts about all SCSI devices for all host system in the given cluster is returned. This parameter is required, if `esxi_hostname` is not provided.
esxi_hostname (added in 2.6)		Name of the ESXi host system. Facts about all SCSI devices for the given ESXi host system is returned. This parameter is required, if `cluster_name` is not provided.
hostname str		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 `VMWARE_HOST` will be used instead. Environment variable supported added in version 2.6.
password str		The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable `VMWARE_PASSWORD` will be used instead. Environment variable supported added in version 2.6. aliases: pass, pwd
port int (added in 2.5)	Default: 443	The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable `VMWARE_PORT` will be used instead. Environment variable supported added in version 2.6.
target_id		The target id based on order of scsi device. version 2.6 onwards, this parameter is optional.
username str		The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable `VMWARE_USER` will be used instead. Environment variable supported added in version 2.6. aliases: admin, user
validate_certs bool	Choices: no yes ←	Allows connection when SSL certificates are not valid. Set to `false` when certificates are not trusted. If the value is not specified in the task, the value of environment variable `VMWARE_VALIDATE_CERTS` will be used instead. Environment variable supported added in version 2.6. If set to `yes`, please make sure Python >= 2.7.9 is installed on the given machine.

Examples ¶

- name: Get Canonical name of particular target on particular ESXi host system
  vmware_target_canonical_facts:
    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
  vmware_target_canonical_facts:
    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
  vmware_target_canonical_facts:
    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	Returned	Description
canonical str	if host system and target id is given	metadata about SCSI Target device Sample: mpx.vmhba0:C0:T0:L0
scsi_tgt_facts dict	if host system or cluster is given	metadata about all SCSI Target devices Sample: {'DC0_C0_H1': {'target_lun_uuid': {'0': 'key-vim.host.ScsiDisk-0000000000766d686261303a303a30'}, 'scsilun_canonical': {'key-vim.host.ScsiDisk-0000000000766d686261303a303a30': 'mpx.vmhba0:C0:T0:L0', 'key-vim.host.ScsiLun-0005000000766d686261313a303a30': 'mpx.vmhba1:C0:T0:L0'}}, 'DC0_C0_H0': {'target_lun_uuid': {'0': 'key-vim.host.ScsiDisk-0000000000766d686261303a303a30'}, 'scsilun_canonical': {'key-vim.host.ScsiDisk-0000000000766d686261303a303a30': 'mpx.vmhba0:C0:T0:L0', 'key-vim.host.ScsiLun-0005000000766d686261313a303a30': 'mpx.vmhba1:C0:T0:L0'}}}

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance ¶

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author ¶

Joseph Callen (@jcpowermac)
Abhijeet Kasurde (@Akasurde)

Hint

If you notice any issues in this documentation you can edit this document to improve it.