xenorchestra.getHosts

Explore with Pulumi AI

xenorchestra v1.5.0 published on Friday, Mar 7, 2025 by Vates

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(args: GetHostsArgs, opts?: InvokeOptions): Promise<GetHostsResult>
function getHostsOutput(args: GetHostsOutputArgs, opts?: InvokeOptions): Output<GetHostsResult>

def get_hosts(pool_id: Optional[str] = None,
              sort_by: Optional[str] = None,
              sort_order: Optional[str] = None,
              tags: Optional[Sequence[str]] = None,
              opts: Optional[InvokeOptions] = None) -> GetHostsResult
def get_hosts_output(pool_id: Optional[pulumi.Input[str]] = None,
              sort_by: Optional[pulumi.Input[str]] = None,
              sort_order: Optional[pulumi.Input[str]] = None,
              tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetHostsResult]

func GetHosts(ctx *Context, args *GetHostsArgs, opts ...InvokeOption) (*GetHostsResult, error)
func GetHostsOutput(ctx *Context, args *GetHostsOutputArgs, opts ...InvokeOption) GetHostsResultOutput

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

public static class GetHosts 
{
    public static Task<GetHostsResult> InvokeAsync(GetHostsArgs args, InvokeOptions? opts = null)
    public static Output<GetHostsResult> Invoke(GetHostsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetHostsResult> getHosts(GetHostsArgs args, InvokeOptions options)
public static Output<GetHostsResult> getHosts(GetHostsArgs args, InvokeOptions options)

fn::invoke:
  function: xenorchestra:index/getHosts:getHosts
  arguments:
    # arguments dictionary

The following arguments are supported:

PoolId string: The pool id used to filter the resulting hosts by.
SortBy string: The host field to sort the results by (id and name_label are supported).
SortOrder string: Valid options are asc or desc and sort order is applied to sort_by argument.
Tags List<string>: The tags (labels) applied to the given entity.

PoolId string: The pool id used to filter the resulting hosts by.
SortBy string: The host field to sort the results by (id and name_label are supported).
SortOrder string: Valid options are asc or desc and sort order is applied to sort_by argument.
Tags []string: The tags (labels) applied to the given entity.

poolId String: The pool id used to filter the resulting hosts by.
sortBy String: The host field to sort the results by (id and name_label are supported).
sortOrder String: Valid options are asc or desc and sort order is applied to sort_by argument.
tags List<String>: The tags (labels) applied to the given entity.

poolId string: The pool id used to filter the resulting hosts by.
sortBy string: The host field to sort the results by (id and name_label are supported).
sortOrder string: Valid options are asc or desc and sort order is applied to sort_by argument.
tags string[]: The tags (labels) applied to the given entity.

pool_id str: The pool id used to filter the resulting hosts by.
sort_by str: The host field to sort the results by (id and name_label are supported).
sort_order str: Valid options are asc or desc and sort order is applied to sort_by argument.
tags Sequence[str]: The tags (labels) applied to the given entity.

poolId String: The pool id used to filter the resulting hosts by.
sortBy String: The host field to sort the results by (id and name_label are supported).
sortOrder String: Valid options are asc or desc and sort order is applied to sort_by argument.
tags List<String>: The tags (labels) applied to the given entity.

getHosts Result

The following output properties are available:

Hosts List<GetHostsHost>: The resulting hosts after applying the argument filtering.
Id string: The provider-assigned unique ID for this managed resource.
Master string: The primary host of the pool.
PoolId string: The pool id used to filter the resulting hosts by.
SortBy string: The host field to sort the results by (id and name_label are supported).
SortOrder string: Valid options are asc or desc and sort order is applied to sort_by argument.
Tags List<string>: The tags (labels) applied to the given entity.

Hosts []GetHostsHost: The resulting hosts after applying the argument filtering.
Id string: The provider-assigned unique ID for this managed resource.
Master string: The primary host of the pool.
PoolId string: The pool id used to filter the resulting hosts by.
SortBy string: The host field to sort the results by (id and name_label are supported).
SortOrder string: Valid options are asc or desc and sort order is applied to sort_by argument.
Tags []string: The tags (labels) applied to the given entity.

hosts List<GetHostsHost>: The resulting hosts after applying the argument filtering.
id String: The provider-assigned unique ID for this managed resource.
master String: The primary host of the pool.
poolId String: The pool id used to filter the resulting hosts by.
sortBy String: The host field to sort the results by (id and name_label are supported).
sortOrder String: Valid options are asc or desc and sort order is applied to sort_by argument.
tags List<String>: The tags (labels) applied to the given entity.

hosts GetHostsHost[]: The resulting hosts after applying the argument filtering.
id string: The provider-assigned unique ID for this managed resource.
master string: The primary host of the pool.
poolId string: The pool id used to filter the resulting hosts by.
sortBy string: The host field to sort the results by (id and name_label are supported).
sortOrder string: Valid options are asc or desc and sort order is applied to sort_by argument.
tags string[]: The tags (labels) applied to the given entity.

hosts Sequence[GetHostsHost]: The resulting hosts after applying the argument filtering.
id str: The provider-assigned unique ID for this managed resource.
master str: The primary host of the pool.
pool_id str: The pool id used to filter the resulting hosts by.
sort_by str: The host field to sort the results by (id and name_label are supported).
sort_order str: Valid options are asc or desc and sort order is applied to sort_by argument.
tags Sequence[str]: The tags (labels) applied to the given entity.

hosts List<Property Map>: The resulting hosts after applying the argument filtering.
id String: The provider-assigned unique ID for this managed resource.
master String: The primary host of the pool.
poolId String: The pool id used to filter the resulting hosts by.
sortBy String: The host field to sort the results by (id and name_label are supported).
sortOrder String: Valid options are asc or desc and sort order is applied to sort_by argument.
tags List<String>: The tags (labels) applied to the given entity.

Supporting Types

GetHostsHost

Cpus Dictionary<string, int>: CPU information about the host. The 'cores' key will contain the number of cpu cores and the 'sockets' key will contain the number of sockets.
Id string
Memory int: The memory size of the host.
MemoryUsage int: The memory usage of the host.
NameLabel string: The name label of the host.
PoolId string: Id of the pool that the host belongs to.
Tags List<string>: The tags (labels) applied to the given entity.

Cpus map[string]int: CPU information about the host. The 'cores' key will contain the number of cpu cores and the 'sockets' key will contain the number of sockets.
Id string
Memory int: The memory size of the host.
MemoryUsage int: The memory usage of the host.
NameLabel string: The name label of the host.
PoolId string: Id of the pool that the host belongs to.
Tags []string: The tags (labels) applied to the given entity.

cpus Map<String,Integer>: CPU information about the host. The 'cores' key will contain the number of cpu cores and the 'sockets' key will contain the number of sockets.
id String
memory Integer: The memory size of the host.
memoryUsage Integer: The memory usage of the host.
nameLabel String: The name label of the host.
poolId String: Id of the pool that the host belongs to.
tags List<String>: The tags (labels) applied to the given entity.

cpus {[key: string]: number}: CPU information about the host. The 'cores' key will contain the number of cpu cores and the 'sockets' key will contain the number of sockets.
id string
memory number: The memory size of the host.
memoryUsage number: The memory usage of the host.
nameLabel string: The name label of the host.
poolId string: Id of the pool that the host belongs to.
tags string[]: The tags (labels) applied to the given entity.

cpus Mapping[str, int]: CPU information about the host. The 'cores' key will contain the number of cpu cores and the 'sockets' key will contain the number of sockets.
id str
memory int: The memory size of the host.
memory_usage int: The memory usage of the host.
name_label str: The name label of the host.
pool_id str: Id of the pool that the host belongs to.
tags Sequence[str]: The tags (labels) applied to the given entity.

cpus Map<Number>: CPU information about the host. The 'cores' key will contain the number of cpu cores and the 'sockets' key will contain the number of sockets.
id String
memory Number: The memory size of the host.
memoryUsage Number: The memory usage of the host.
nameLabel String: The name label of the host.
poolId String: Id of the pool that the host belongs to.
tags List<String>: The tags (labels) applied to the given entity.

Package Details

Repository: xenorchestra vatesfr/pulumi-xenorchestra
License: Apache-2.0
Notes: This Pulumi package is based on the xenorchestra Terraform Provider.

xenorchestra v1.5.0 published on Friday, Mar 7, 2025 by Vates

vatesfr/pulumi-xenorchestra

xenorchestra.getHosts

On this page

On this page

Using getHosts

getHosts Result

Supporting Types

GetHostsHost

Package Details

On this page

On this page