Nutanix v0.7.4, Mar 21 25

Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg

nutanix.getHostsV2

Explore with Pulumi AI

Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nutanix.NutanixFunctions;
import com.pulumi.nutanix.inputs.GetHostV2Args;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = NutanixFunctions.getHostV2(GetHostV2Args.builder()
            .filter("cluster/name eq '<cluster name>'")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: nutanix:getHostV2
      arguments:
        filter: cluster/name eq '<cluster name>'

Host Entities

The host_entities attribute supports the following:

ext_id: - A globally unique identifier of an instance that is suitable for external consumption.
tenant_id: - image uuid.
links: - A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
host_name: - Name of the host.
host_type: - Type of the host.
- HYPER_CONVERGED: Hyper-converged node.
- COMPUTE_ONLY: Compute only node.
- STORAGE_ONLY: Storage only node.
hypervisor: - Hypervisor details.
cluster: - Cluster reference for an entity.
controller_vm: - Host entity with its attributes.
disk: - Disks attached to host.
is_degraded: - Node degraded status.
is_secure_booted: - Secure boot status.
is_hardware_virtualized: - Indicates whether the hardware is virtualized or not.
has_csr: - Certificate signing request status.
key_management_device_to_cert_status: - Mapping of key management device to certificate status list.
number_of_cpu_cores: - Number of CPU cores.
number_of_cpu_threads: - Number of CPU threads.
number_of_cpu_sockets: - Number of CPU sockets.
cpu_capacity_hz: - CPU capacity in Hz.
cpu_frequency_hz: - CPU frequency in Hz.
cpu_model: - CPU model name.
gpu_driver_version: - GPU driver version.
gpu_list: - GPU attached list.
default_vhd_location: - Default VHD location.
default_vhd_container_uuid: - Default VHD container UUID.
default_vm_location: - Default VM location.
default_vm_container_uuid: - Default VM container UUID.
reboot_pending: - Reboot pending status.
failover_cluster_fqdn: - Failover cluster FQDN.
failover_cluster_node_status: - Failover cluster node status.
boot_time_usecs: - Boot time in secs.
memory_size_bytes: - Memory size in bytes.
block_serial: - Rackable unit serial name.
block_model: - Rackable unit model name.
maintenance_state: - Host Maintenance State.
node_status: - Node status.
- TO_BE_PREPROTECTED: Node to be preprotected.
- TO_BE_REMOVED: Node to be removed.
- PREPROTECTED: Node is preprotected.
- OK_TO_BE_REMOVED: Indicates whether removing the node from the cluster is adequate.
- NORMAL: Normal node.
- NEW_NODE: New node.

Hypervisor

The hypervisor attribute supports the following:

external_address: - An unique address that identifies a device on the internet or a local network in IPv4 or IPv6 format.
user_name: - Hypervisor user name.
full_name: - Hypervisor full name.
type: - Hypervisor type.
- XEN: Xen hypervisor.
- HYPERV: HyperV hypervisor.
- ESX: ESX hypervisor.
- AHV: AHV hypervisor.
number_of_vms: - Number of VMs.
state: - Hypervisor state.
- HA_HEALING_TARGET: Hypervisor in HA healing target state.
- ENTERING_MAINTENANCE_MODE: Hypervisor entering maintenance mode.
- RESERVED_FOR_HA_FAILOVER: Hypervisor reserved for HA failover.
- HA_HEALING_SOURCE: Hypervisor in HA healing source state.
- RESERVING_FOR_HA_FAILOVER: Hypervisor that is planned to be reserved for HA failover.
- HA_FAILOVER_SOURCE: Hypervisor in HA failover source state.
- ACROPOLIS_NORMAL: Hypervisor in Acropolis normal state.
- ENTERED_MAINTENANCE_MODE: Hypervisor entered maintenance mode.
- ENTERING_MAINTENANCE_MODE_FROM_HA_FAILOVER: Hypervisor entering maintenance mode from HA failover.
- HA_FAILOVER_TARGET: Hypervisor in HA failover target state.
acropolis_connection_state: - Status of Acropolis connection to hypervisor.
- DISCONNECTED: Acropolis disconnected.
- CONNECTED: Acropolis connected.

Cluster

The cluster attribute supports the following:

uuid: - Cluster UUID.
name: - Cluster name. This is part of payload for both cluster create & update operations.

Controller VM

The controller_vm attribute supports the following:

id: - Controller VM Id.
external_address: - An unique address that identifies a device on the internet or a local network in IPv4 or IPv6 format.
backplane_address: - An unique address that identifies a device on the internet or a local network in IPv4 or IPv6 format.
rdma_backplane_address: - RDMA backplane address.
ipmi: - IPMI reference.
nat_ip: - An unique address that identifies a device on the internet or a local network in IPv4 or IPv6 format.
nat_port: - NAT port.
maintenance_mode: - Maintenance mode status.
rackable_unit_uuid: - Rackable unit UUID.

Disk

The disk attribute supports the following:

uuid: - Disk UUID.
mount_path: - Disk mount path.
size_in_bytes: - Disk size.
serial_id: - Disk serial Id.
storage_tier: - Disk storage Tier type.
- HDD: HDD storage tier.
- PCIE_SSD: PCIE SSD storage tier.
- SATA_SSD: SATA SSD storage tier.

key Management Device To Cert Status

The key_management_device_to_cert_status attribute supports the following:

key_management_server_name: - Key management server name.
status: - Certificate status.

external Address

The external_address attribute supports the following:

ipv4: - An unique address that identifies a device on the internet or a local network in IPv4 format.
ipv6: - An unique address that identifies a device on the internet or a local network in IPv6 format.

Backplane Address

The backplane_address attribute supports the following:

ipv4: - An unique address that identifies a device on the internet or a local network in IPv4 format.
ipv6: - An unique address that identifies a device on the internet or a local network in IPv6 format.

Rdma Backplane Address

The rdma_backplane_address attribute supports the following:

ipv4: - An unique address that identifies a device on the internet or a local network in IPv4 format.
ipv6: - An unique address that identifies a device on the internet or a local network in IPv6 format.

ipmi

The ipmi attribute supports the following:

ip: - An unique address that identifies a device on the internet or a local network in IPv4 or IPv6 format.
username: - IPMI username.

Nat Ip

The nat_ip attribute supports the following:

ipv4: - An unique address that identifies a device on the internet or a local network in IPv4 format.
ipv6: - An unique address that identifies a device on the internet or a local network in IPv6 format.

ip

The ip attribute supports the following:

ipv4: - An unique address that identifies a device on the internet or a local network in IPv4 format.
ipv6: - An unique address that identifies a device on the internet or a local network in IPv6 format.

IPV4

The ipv4 attribute supports the following:

value: - An unique address that identifies a device on the internet or a local network in IPv4 format.
prefix_length: - The prefix length of the network to which this host IPv4 address belongs.

IPV6

The ipv6 attribute supports the following:

value: - An unique address that identifies a device on the internet or a local network in IPv6 format.
prefix_length: - The prefix length of the network to which this host IPv6 address belongs.

See detailed information in Nutanix Hosts V4.

Using getHostsV2

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 getHostsV2(args: GetHostsV2Args, opts?: InvokeOptions): Promise<GetHostsV2Result>
function getHostsV2Output(args: GetHostsV2OutputArgs, opts?: InvokeOptions): Output<GetHostsV2Result>

def get_hosts_v2(apply: Optional[str] = None,
                 filter: Optional[str] = None,
                 limit: Optional[int] = None,
                 order_by: Optional[str] = None,
                 page: Optional[int] = None,
                 select: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetHostsV2Result
def get_hosts_v2_output(apply: Optional[pulumi.Input[str]] = None,
                 filter: Optional[pulumi.Input[str]] = None,
                 limit: Optional[pulumi.Input[int]] = None,
                 order_by: Optional[pulumi.Input[str]] = None,
                 page: Optional[pulumi.Input[int]] = None,
                 select: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetHostsV2Result]

func GetHostsV2(ctx *Context, args *GetHostsV2Args, opts ...InvokeOption) (*GetHostsV2Result, error)
func GetHostsV2Output(ctx *Context, args *GetHostsV2OutputArgs, opts ...InvokeOption) GetHostsV2ResultOutput

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

public static class GetHostsV2 
{
    public static Task<GetHostsV2Result> InvokeAsync(GetHostsV2Args args, InvokeOptions? opts = null)
    public static Output<GetHostsV2Result> Invoke(GetHostsV2InvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetHostsV2Result> getHostsV2(GetHostsV2Args args, InvokeOptions options)
public static Output<GetHostsV2Result> getHostsV2(GetHostsV2Args args, InvokeOptions options)

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

The following arguments are supported:

Apply string

-(Optional) A URL query parameter that allows clients to specify a sequence of transformations to the entity set, such as groupby, filter, aggregate etc. As of now only support for groupby exists.For example '$apply=groupby((templateName))' would get all templates grouped by templateName. The groupby can be applied on the following fields:

cluster/name
hypervisor/type

Filter string

-(Optional) A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the OData V4.01 URL conventions. For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'. The filter can be applied to the following fields:

bootTimeUsecs
cluster/name
cluster/uuid
cpuCapacityHz
cpuFrequencyHz
cpuModel
defaultVhdContainerUuid
defaultVhdLocation
defaultVmContainerUuid
defaultVmLocation
extId
gpuDriverVersion
gpuList
hostName
hypervisor/type
memorySizeBytes
numberOfCpuCores
numberOfCpuSockets
numberOfCpuThreads

Limit int

-(Optional) A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.

OrderBy string

Page int

-(Optional) A query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource.

Select string

-(Optional) A query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the OData V4.01 URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned. The select can be applied to the following fields:

blockModel
blockSerial
bootTimeUsecs

Apply string

cluster/name
hypervisor/type

Filter string

bootTimeUsecs
cluster/name
cluster/uuid
cpuCapacityHz
cpuFrequencyHz
cpuModel
defaultVhdContainerUuid
defaultVhdLocation
defaultVmContainerUuid
defaultVmLocation
extId
gpuDriverVersion
gpuList
hostName
hypervisor/type
memorySizeBytes
numberOfCpuCores
numberOfCpuSockets
numberOfCpuThreads

Limit int

OrderBy string

Page int

-(Optional) A query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource.

Select string

blockModel
blockSerial
bootTimeUsecs

apply String

cluster/name
hypervisor/type

filter String

bootTimeUsecs
cluster/name
cluster/uuid
cpuCapacityHz
cpuFrequencyHz
cpuModel
defaultVhdContainerUuid
defaultVhdLocation
defaultVmContainerUuid
defaultVmLocation
extId
gpuDriverVersion
gpuList
hostName
hypervisor/type
memorySizeBytes
numberOfCpuCores
numberOfCpuSockets
numberOfCpuThreads

limit Integer

orderBy String

page Integer

-(Optional) A query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource.

select String

blockModel
blockSerial
bootTimeUsecs

apply string

cluster/name
hypervisor/type

filter string

bootTimeUsecs
cluster/name
cluster/uuid
cpuCapacityHz
cpuFrequencyHz
cpuModel
defaultVhdContainerUuid
defaultVhdLocation
defaultVmContainerUuid
defaultVmLocation
extId
gpuDriverVersion
gpuList
hostName
hypervisor/type
memorySizeBytes
numberOfCpuCores
numberOfCpuSockets
numberOfCpuThreads

limit number

orderBy string

page number

-(Optional) A query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource.

select string

blockModel
blockSerial
bootTimeUsecs

apply str

cluster/name
hypervisor/type

filter str

bootTimeUsecs
cluster/name
cluster/uuid
cpuCapacityHz
cpuFrequencyHz
cpuModel
defaultVhdContainerUuid
defaultVhdLocation
defaultVmContainerUuid
defaultVmLocation
extId
gpuDriverVersion
gpuList
hostName
hypervisor/type
memorySizeBytes
numberOfCpuCores
numberOfCpuSockets
numberOfCpuThreads

limit int

order_by str

page int

-(Optional) A query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource.

select str

blockModel
blockSerial
bootTimeUsecs

apply String

cluster/name
hypervisor/type

filter String

bootTimeUsecs
cluster/name
cluster/uuid
cpuCapacityHz
cpuFrequencyHz
cpuModel
defaultVhdContainerUuid
defaultVhdLocation
defaultVmContainerUuid
defaultVmLocation
extId
gpuDriverVersion
gpuList
hostName
hypervisor/type
memorySizeBytes
numberOfCpuCores
numberOfCpuSockets
numberOfCpuThreads

limit Number

orderBy String

page Number

-(Optional) A query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource.

select String