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

nutanix.getHost

Explore with Pulumi AI

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

    Describes a Host

    Using getHost

    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 getHost(args: GetHostArgs, opts?: InvokeOptions): Promise<GetHostResult>
function getHostOutput(args: GetHostOutputArgs, opts?: InvokeOptions): Output<GetHostResult>
    def get_host(categories: Optional[Sequence[GetHostCategory]] = None,
             host_id: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetHostResult
def get_host_output(categories: Optional[pulumi.Input[Sequence[pulumi.Input[GetHostCategoryArgs]]]] = None,
             host_id: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetHostResult]
    func GetHost(ctx *Context, args *GetHostArgs, opts ...InvokeOption) (*GetHostResult, error)
func GetHostOutput(ctx *Context, args *GetHostOutputArgs, opts ...InvokeOption) GetHostResultOutput

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

    public static class GetHost 
{
    public static Task<GetHostResult> InvokeAsync(GetHostArgs args, InvokeOptions? opts = null)
    public static Output<GetHostResult> Invoke(GetHostInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetHostResult> getHost(GetHostArgs args, InvokeOptions options)
public static Output<GetHostResult> getHost(GetHostArgs args, InvokeOptions options)

    fn::invoke:
  function: nutanix:index/getHost:getHost
  arguments:
    # arguments dictionary

    The following arguments are supported:

    HostId string
    Represents hosts uuid
    Categories List<PiersKarsenbarg.Nutanix.Inputs.GetHostCategory>
    • Categories for the image.
    HostId string
    Represents hosts uuid
    Categories []GetHostCategory
    • Categories for the image.
    hostId String
    Represents hosts uuid
    categories List<GetHostCategory>
    • Categories for the image.
    hostId string
    Represents hosts uuid
    categories GetHostCategory[]
    • Categories for the image.
    host_id str
    Represents hosts uuid
    categories Sequence[GetHostCategory]
    • Categories for the image.
    hostId String
    Represents hosts uuid
    categories List<Property Map>
    • Categories for the image.

    getHost Result

    The following output properties are available:

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

    Supporting Types

    GetHostCategory

    Name string
    • the key name.
    Value string
    • value of the key.
    Name string
    • the key name.
    Value string
    • value of the key.
    name String
    • the key name.
    value String
    • value of the key.
    name string
    • the key name.
    value string
    • value of the key.
    name str
    • the key name.
    value str
    • value of the key.
    name String
    • the key name.
    value String
    • value of the key.

    GetHostGpuList

    Assignable bool
    ConsumerReference Dictionary<string, string>
    DeviceId int
    Fraction int
    FrameBufferSizeMib int
    GuestDriverVersion string
    Index int
    LicenseLists List<string>
    MaxResolution string
    Mode string
    Name string
    • the name.
    NumVgpusAllocated int
    NumVirtualDisplayHeads int
    NumaNode int
    PciAddress string
    Status string
    Uuid string
    • the uuid.
    Vendor string
    Assignable bool
    ConsumerReference map[string]string
    DeviceId int
    Fraction int
    FrameBufferSizeMib int
    GuestDriverVersion string
    Index int
    LicenseLists []string
    MaxResolution string
    Mode string
    Name string
    • the name.
    NumVgpusAllocated int
    NumVirtualDisplayHeads int
    NumaNode int
    PciAddress string
    Status string
    Uuid string
    • the uuid.
    Vendor string
    assignable Boolean
    consumerReference Map<String,String>
    deviceId Integer
    fraction Integer
    frameBufferSizeMib Integer
    guestDriverVersion String
    index Integer
    licenseLists List<String>
    maxResolution String
    mode String
    name String
    • the name.
    numVgpusAllocated Integer
    numVirtualDisplayHeads Integer
    numaNode Integer
    pciAddress String
    status String
    uuid String
    • the uuid.
    vendor String
    assignable boolean
    consumerReference {[key: string]: string}
    deviceId number
    fraction number
    frameBufferSizeMib number
    guestDriverVersion string
    index number
    licenseLists string[]
    maxResolution string
    mode string
    name string
    • the name.
    numVgpusAllocated number
    numVirtualDisplayHeads number
    numaNode number
    pciAddress string
    status string
    uuid string
    • the uuid.
    vendor string
    assignable Boolean
    consumerReference Map<String>
    deviceId Number
    fraction Number
    frameBufferSizeMib Number
    guestDriverVersion String
    index Number
    licenseLists List<String>
    maxResolution String
    mode String
    name String
    • the name.
    numVgpusAllocated Number
    numVirtualDisplayHeads Number
    numaNode Number
    pciAddress String
    status String
    uuid String
    • the uuid.
    vendor String

    GetHostHostDisksReferenceList

    Kind string
    • The kind name (Default value: project).
    Name string
    • the name.
    Uuid string
    • the uuid.
    Kind string
    • The kind name (Default value: project).
    Name string
    • the name.
    Uuid string
    • the uuid.
    kind String
    • The kind name (Default value: project).
    name String
    • the name.
    uuid String
    • the uuid.
    kind string
    • The kind name (Default value: project).
    name string
    • the name.
    uuid string
    • the uuid.
    kind str
    • The kind name (Default value: project).
    name str
    • the name.
    uuid str
    • the uuid.
    kind String
    • The kind name (Default value: project).
    name String
    • the name.
    uuid 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 logo
    Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
    pierskarsenbarg/pulumi-nutanix