Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nutanix
  3. API Docs
  4. getHosts
Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

nutanix.getHosts

Explore with Pulumi AI

Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

Describes a list of hosts

Using getHosts

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getHosts(opts?: InvokeOptions): Promise<GetHostsResult>
function getHostsOutput(opts?: InvokeOptions): Output<GetHostsResult>
Copy
def get_hosts(opts: Optional[InvokeOptions] = None) -> GetHostsResult
def get_hosts_output(opts: Optional[InvokeOptions] = None) -> Output[GetHostsResult]
Copy
func GetHosts(ctx *Context, opts ...InvokeOption) (*GetHostsResult, error)
func GetHostsOutput(ctx *Context, opts ...InvokeOption) GetHostsResultOutput
Copy

> Note: This function is named GetHosts in the Go SDK.

public static class GetHosts 
{
    public static Task<GetHostsResult> InvokeAsync(InvokeOptions? opts = null)
    public static Output<GetHostsResult> Invoke(InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetHostsResult> getHosts(InvokeOptions options)
public static Output<GetHostsResult> getHosts(InvokeOptions options)
Copy
fn::invoke:
  function: nutanix:index/getHosts:getHosts
  arguments:
    # arguments dictionary
Copy

getHosts Result

The following output properties are available:

ApiVersion string
The API version.
Entities List<PiersKarsenbarg.Nutanix.Outputs.GetHostsEntity>
List of Hosts
Id string
The provider-assigned unique ID for this managed resource.
ApiVersion string
The API version.
Entities []GetHostsEntity
List of Hosts
Id string
The provider-assigned unique ID for this managed resource.
apiVersion String
The API version.
entities List<GetHostsEntity>
List of Hosts
id String
The provider-assigned unique ID for this managed resource.
apiVersion string
The API version.
entities GetHostsEntity[]
List of Hosts
id string
The provider-assigned unique ID for this managed resource.
api_version str
The API version.
entities Sequence[GetHostsEntity]
List of Hosts
id str
The provider-assigned unique ID for this managed resource.
apiVersion String
The API version.
entities List<Property Map>
List of Hosts
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

GetHostsEntity

ApiVersion This property is required. string
The API version.
Block This property is required. Dictionary<string, string>
  • Host block config info.
Categories This property is required. List<PiersKarsenbarg.Nutanix.Inputs.GetHostsEntityCategory>
  • Categories for the image.
ClusterReference This property is required. Dictionary<string, string>
  • Reference to a kind. Either one of (kind, uuid) or url needs to be specified.
ControllerVm This property is required. Dictionary<string, string>
  • Host controller vm information.
CpuCapacityHz This property is required. int
  • Host CPU capacity.
CpuModel This property is required. string
  • Host CPU model.
FailoverCluster This property is required. Dictionary<string, string>
  • Hyper-V failover cluster.
GpuDriverVersion This property is required. string
  • Host GPU driver version.
GpuLists This property is required. List<PiersKarsenbarg.Nutanix.Inputs.GetHostsEntityGpuList>
  • List of GPUs on the host.
HostDisksReferenceLists This property is required. List<PiersKarsenbarg.Nutanix.Inputs.GetHostsEntityHostDisksReferenceList>
  • The reference to a disk.
HostNicsIdLists This property is required. List<string>
  • Host NICs.
HostType This property is required. string
  • Host type.
Hypervisor This property is required. Dictionary<string, string>
  • Host Hypervisor information.
Ipmi This property is required. Dictionary<string, string>
  • Host IPMI info.
MemoryCapacityMib This property is required. int
  • Host memory capacity in MiB.
Metadata This property is required. Dictionary<string, string>
MonitoringState This property is required. string
  • Host monitoring status.
Name This property is required. string
  • the name.
NumCpuCores This property is required. int
  • Number of CPU cores on Host.
NumCpuSockets This property is required. int
  • Number of CPU sockets.
OwnerReference This property is required. Dictionary<string, string>
  • The reference to a user.
ProjectReference This property is required. Dictionary<string, string>
  • The reference to a project.
RackableUnitReference This property is required. Dictionary<string, string>
  • The reference to a rackable_unit.
SerialNumber This property is required. string
  • Node serial number.
WindowsDomain This property is required. Dictionary<string, string>
  • The name of the node to be renamed to during domain-join. If not given,a new name will be automatically assigned.
ApiVersion This property is required. string
The API version.
Block This property is required. map[string]string
  • Host block config info.
Categories This property is required. []GetHostsEntityCategory
  • Categories for the image.
ClusterReference This property is required. map[string]string
  • Reference to a kind. Either one of (kind, uuid) or url needs to be specified.
ControllerVm This property is required. map[string]string
  • Host controller vm information.
CpuCapacityHz This property is required. int
  • Host CPU capacity.
CpuModel This property is required. string
  • Host CPU model.
FailoverCluster This property is required. map[string]string
  • Hyper-V failover cluster.
GpuDriverVersion This property is required. string
  • Host GPU driver version.
GpuLists This property is required. []GetHostsEntityGpuList
  • List of GPUs on the host.
HostDisksReferenceLists This property is required. []GetHostsEntityHostDisksReferenceList
  • The reference to a disk.
HostNicsIdLists This property is required. []string
  • Host NICs.
HostType This property is required. string
  • Host type.
Hypervisor This property is required. map[string]string
  • Host Hypervisor information.
Ipmi This property is required. map[string]string
  • Host IPMI info.
MemoryCapacityMib This property is required. int
  • Host memory capacity in MiB.
Metadata This property is required. map[string]string
MonitoringState This property is required. string
  • Host monitoring status.
Name This property is required. string
  • the name.
NumCpuCores This property is required. int
  • Number of CPU cores on Host.
NumCpuSockets This property is required. int
  • Number of CPU sockets.
OwnerReference This property is required. map[string]string
  • The reference to a user.
ProjectReference This property is required. map[string]string
  • The reference to a project.
RackableUnitReference This property is required. map[string]string
  • The reference to a rackable_unit.
SerialNumber This property is required. string
  • Node serial number.
WindowsDomain This property is required. map[string]string
  • The name of the node to be renamed to during domain-join. If not given,a new name will be automatically assigned.
apiVersion This property is required. String
The API version.
block This property is required. Map<String,String>
  • Host block config info.
categories This property is required. List<GetHostsEntityCategory>
  • Categories for the image.
clusterReference This property is required. Map<String,String>
  • Reference to a kind. Either one of (kind, uuid) or url needs to be specified.
controllerVm This property is required. Map<String,String>
  • Host controller vm information.
cpuCapacityHz This property is required. Integer
  • Host CPU capacity.
cpuModel This property is required. String
  • Host CPU model.
failoverCluster This property is required. Map<String,String>
  • Hyper-V failover cluster.
gpuDriverVersion This property is required. String
  • Host GPU driver version.
gpuLists This property is required. List<GetHostsEntityGpuList>
  • List of GPUs on the host.
hostDisksReferenceLists This property is required. List<GetHostsEntityHostDisksReferenceList>
  • The reference to a disk.
hostNicsIdLists This property is required. List<String>
  • Host NICs.
hostType This property is required. String
  • Host type.
hypervisor This property is required. Map<String,String>
  • Host Hypervisor information.
ipmi This property is required. Map<String,String>
  • Host IPMI info.
memoryCapacityMib This property is required. Integer
  • Host memory capacity in MiB.
metadata This property is required. Map<String,String>
monitoringState This property is required. String
  • Host monitoring status.
name This property is required. String
  • the name.
numCpuCores This property is required. Integer
  • Number of CPU cores on Host.
numCpuSockets This property is required. Integer
  • Number of CPU sockets.
ownerReference This property is required. Map<String,String>
  • The reference to a user.
projectReference This property is required. Map<String,String>
  • The reference to a project.
rackableUnitReference This property is required. Map<String,String>
  • The reference to a rackable_unit.
serialNumber This property is required. String
  • Node serial number.
windowsDomain This property is required. Map<String,String>
  • The name of the node to be renamed to during domain-join. If not given,a new name will be automatically assigned.
apiVersion This property is required. string
The API version.
block This property is required. {[key: string]: string}
  • Host block config info.
categories This property is required. GetHostsEntityCategory[]
  • Categories for the image.
clusterReference This property is required. {[key: string]: string}
  • Reference to a kind. Either one of (kind, uuid) or url needs to be specified.
controllerVm This property is required. {[key: string]: string}
  • Host controller vm information.
cpuCapacityHz This property is required. number
  • Host CPU capacity.
cpuModel This property is required. string
  • Host CPU model.
failoverCluster This property is required. {[key: string]: string}
  • Hyper-V failover cluster.
gpuDriverVersion This property is required. string
  • Host GPU driver version.
gpuLists This property is required. GetHostsEntityGpuList[]
  • List of GPUs on the host.
hostDisksReferenceLists This property is required. GetHostsEntityHostDisksReferenceList[]
  • The reference to a disk.
hostNicsIdLists This property is required. string[]
  • Host NICs.
hostType This property is required. string
  • Host type.
hypervisor This property is required. {[key: string]: string}
  • Host Hypervisor information.
ipmi This property is required. {[key: string]: string}
  • Host IPMI info.
memoryCapacityMib This property is required. number
  • Host memory capacity in MiB.
metadata This property is required. {[key: string]: string}
monitoringState This property is required. string
  • Host monitoring status.
name This property is required. string
  • the name.
numCpuCores This property is required. number
  • Number of CPU cores on Host.
numCpuSockets This property is required. number
  • Number of CPU sockets.
ownerReference This property is required. {[key: string]: string}
  • The reference to a user.
projectReference This property is required. {[key: string]: string}
  • The reference to a project.
rackableUnitReference This property is required. {[key: string]: string}
  • The reference to a rackable_unit.
serialNumber This property is required. string
  • Node serial number.
windowsDomain This property is required. {[key: string]: string}
  • The name of the node to be renamed to during domain-join. If not given,a new name will be automatically assigned.
api_version This property is required. str
The API version.
block This property is required. Mapping[str, str]
  • Host block config info.
categories This property is required. Sequence[GetHostsEntityCategory]
  • Categories for the image.
cluster_reference This property is required. Mapping[str, str]
  • Reference to a kind. Either one of (kind, uuid) or url needs to be specified.
controller_vm This property is required. Mapping[str, str]
  • Host controller vm information.
cpu_capacity_hz This property is required. int
  • Host CPU capacity.
cpu_model This property is required. str
  • Host CPU model.
failover_cluster This property is required. Mapping[str, str]
  • Hyper-V failover cluster.
gpu_driver_version This property is required. str
  • Host GPU driver version.
gpu_lists This property is required. Sequence[GetHostsEntityGpuList]
  • List of GPUs on the host.
host_disks_reference_lists This property is required. Sequence[GetHostsEntityHostDisksReferenceList]
  • The reference to a disk.
host_nics_id_lists This property is required. Sequence[str]
  • Host NICs.
host_type This property is required. str
  • Host type.
hypervisor This property is required. Mapping[str, str]
  • Host Hypervisor information.
ipmi This property is required. Mapping[str, str]
  • Host IPMI info.
memory_capacity_mib This property is required. int
  • Host memory capacity in MiB.
metadata This property is required. Mapping[str, str]
monitoring_state This property is required. str
  • Host monitoring status.
name This property is required. str
  • the name.
num_cpu_cores This property is required. int
  • Number of CPU cores on Host.
num_cpu_sockets This property is required. int
  • Number of CPU sockets.
owner_reference This property is required. Mapping[str, str]
  • The reference to a user.
project_reference This property is required. Mapping[str, str]
  • The reference to a project.
rackable_unit_reference This property is required. Mapping[str, str]
  • The reference to a rackable_unit.
serial_number This property is required. str
  • Node serial number.
windows_domain This property is required. Mapping[str, str]
  • The name of the node to be renamed to during domain-join. If not given,a new name will be automatically assigned.
apiVersion This property is required. String
The API version.
block This property is required. Map<String>
  • Host block config info.
categories This property is required. List<Property Map>
  • Categories for the image.
clusterReference This property is required. Map<String>
  • Reference to a kind. Either one of (kind, uuid) or url needs to be specified.
controllerVm This property is required. Map<String>
  • Host controller vm information.
cpuCapacityHz This property is required. Number
  • Host CPU capacity.
cpuModel This property is required. String
  • Host CPU model.
failoverCluster This property is required. Map<String>
  • Hyper-V failover cluster.
gpuDriverVersion This property is required. String
  • Host GPU driver version.
gpuLists This property is required. List<Property Map>
  • List of GPUs on the host.
hostDisksReferenceLists This property is required. List<Property Map>
  • The reference to a disk.
hostNicsIdLists This property is required. List<String>
  • Host NICs.
hostType This property is required. String
  • Host type.
hypervisor This property is required. Map<String>
  • Host Hypervisor information.
ipmi This property is required. Map<String>
  • Host IPMI info.
memoryCapacityMib This property is required. Number
  • Host memory capacity in MiB.
metadata This property is required. Map<String>
monitoringState This property is required. String
  • Host monitoring status.
name This property is required. String
  • the name.
numCpuCores This property is required. Number
  • Number of CPU cores on Host.
numCpuSockets This property is required. Number
  • Number of CPU sockets.
ownerReference This property is required. Map<String>
  • The reference to a user.
projectReference This property is required. Map<String>
  • The reference to a project.
rackableUnitReference This property is required. Map<String>
  • The reference to a rackable_unit.
serialNumber This property is required. String
  • Node serial number.
windowsDomain This property is required. Map<String>
  • The name of the node to be renamed to during domain-join. If not given,a new name will be automatically assigned.

GetHostsEntityCategory

Name This property is required. string
  • the name.
Value This property is required. string
  • value of the key.
Name This property is required. string
  • the name.
Value This property is required. string
  • value of the key.
name This property is required. String
  • the name.
value This property is required. String
  • value of the key.
name This property is required. string
  • the name.
value This property is required. string
  • value of the key.
name This property is required. str
  • the name.
value This property is required. str
  • value of the key.
name This property is required. String
  • the name.
value This property is required. String
  • value of the key.

GetHostsEntityGpuList

Assignable This property is required. bool
ConsumerReference This property is required. Dictionary<string, string>
DeviceId This property is required. int
Fraction This property is required. int
FrameBufferSizeMib This property is required. int
GuestDriverVersion This property is required. string
Index This property is required. int
LicenseLists This property is required. List<string>
MaxResolution This property is required. string
Mode This property is required. string
Name This property is required. string
  • the name.
NumVgpusAllocated This property is required. int
NumVirtualDisplayHeads This property is required. int
NumaNode This property is required. int
PciAddress This property is required. string
Status This property is required. string
Uuid This property is required. string
  • the uuid.
Vendor This property is required. string
Assignable This property is required. bool
ConsumerReference This property is required. map[string]string
DeviceId This property is required. int
Fraction This property is required. int
FrameBufferSizeMib This property is required. int
GuestDriverVersion This property is required. string
Index This property is required. int
LicenseLists This property is required. []string
MaxResolution This property is required. string
Mode This property is required. string
Name This property is required. string
  • the name.
NumVgpusAllocated This property is required. int
NumVirtualDisplayHeads This property is required. int
NumaNode This property is required. int
PciAddress This property is required. string
Status This property is required. string
Uuid This property is required. string
  • the uuid.
Vendor This property is required. string
assignable This property is required. Boolean
consumerReference This property is required. Map<String,String>
deviceId This property is required. Integer
fraction This property is required. Integer
frameBufferSizeMib This property is required. Integer
guestDriverVersion This property is required. String
index This property is required. Integer
licenseLists This property is required. List<String>
maxResolution This property is required. String
mode This property is required. String
name This property is required. String
  • the name.
numVgpusAllocated This property is required. Integer
numVirtualDisplayHeads This property is required. Integer
numaNode This property is required. Integer
pciAddress This property is required. String
status This property is required. String
uuid This property is required. String
  • the uuid.
vendor This property is required. String
assignable This property is required. boolean
consumerReference This property is required. {[key: string]: string}
deviceId This property is required. number
fraction This property is required. number
frameBufferSizeMib This property is required. number
guestDriverVersion This property is required. string
index This property is required. number
licenseLists This property is required. string[]
maxResolution This property is required. string
mode This property is required. string
name This property is required. string
  • the name.
numVgpusAllocated This property is required. number
numVirtualDisplayHeads This property is required. number
numaNode This property is required. number
pciAddress This property is required. string
status This property is required. string
uuid This property is required. string
  • the uuid.
vendor This property is required. string
assignable This property is required. bool
consumer_reference This property is required. Mapping[str, str]
device_id This property is required. int
fraction This property is required. int
frame_buffer_size_mib This property is required. int
guest_driver_version This property is required. str
index This property is required. int
license_lists This property is required. Sequence[str]
max_resolution This property is required. str
mode This property is required. str
name This property is required. str
  • the name.
num_vgpus_allocated This property is required. int
num_virtual_display_heads This property is required. int
numa_node This property is required. int
pci_address This property is required. str
status This property is required. str
uuid This property is required. str
  • the uuid.
vendor This property is required. str
assignable This property is required. Boolean
consumerReference This property is required. Map<String>
deviceId This property is required. Number
fraction This property is required. Number
frameBufferSizeMib This property is required. Number
guestDriverVersion This property is required. String
index This property is required. Number
licenseLists This property is required. List<String>
maxResolution This property is required. String
mode This property is required. String
name This property is required. String
  • the name.
numVgpusAllocated This property is required. Number
numVirtualDisplayHeads This property is required. Number
numaNode This property is required. Number
pciAddress This property is required. String
status This property is required. String
uuid This property is required. String
  • the uuid.
vendor This property is required. String

GetHostsEntityHostDisksReferenceList

Kind This property is required. string
  • The kind name (Default value: project).
Name This property is required. string
  • the name.
Uuid This property is required. string
  • the uuid.
Kind This property is required. string
  • The kind name (Default value: project).
Name This property is required. string
  • the name.
Uuid This property is required. string
  • the uuid.
kind This property is required. String
  • The kind name (Default value: project).
name This property is required. String
  • the name.
uuid This property is required. String
  • the uuid.
kind This property is required. string
  • The kind name (Default value: project).
name This property is required. string
  • the name.
uuid This property is required. string
  • the uuid.
kind This property is required. str
  • The kind name (Default value: project).
name This property is required. str
  • the name.
uuid This property is required. str
  • the uuid.
kind This property is required. String
  • The kind name (Default value: project).
name This property is required. String
  • the name.
uuid This property is required. String
  • the uuid.

Package Details

Repository
nutanix pierskarsenbarg/pulumi-nutanix
License
Apache-2.0
Notes
This Pulumi package is based on the nutanix Terraform Provider.
Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix