Documentation

vmware_target_canonical_facts - Return canonical (NAA) from an ESXi host

New in version 2.0.

Synopsis

  • Return 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
  • PyVmomi installed

Parameters

Parameter
Choices/Defaults
Comments
hostname
required
The hostname or IP address of the vSphere vCenter.
password
required
The password of the vSphere vCenter.

aliases: pass, pwd
port
(added in 2.5)
Default:
443
The port number of the vSphere vCenter or ESXi server.
target_id
required
The target id based on order of scsi device
username
required
The username of the vSphere vCenter.

aliases: user, admin
validate_certs
    Choices:
  • no
  • yes
Default:
True
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.

Examples

# Example vmware_target_canonical_facts command from Ansible Playbooks
- name: Get Canonical name
  local_action:
    module: vmware_target_canonical_facts
    hostname: "{{ ansible_ssh_host }}"
    username: root
    password: vmware
    target_id: 7

Status

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

Author

  • Joseph Callen

Hint

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