1. Packages
  2. Xen Orchestra
  3. API Docs
  4. getXoaHosts
xenorchestra v1.5.2 published on Monday, Mar 10, 2025 by Vates

xenorchestra.getXoaHosts

Explore with Pulumi AI

xenorchestra v1.5.2 published on Monday, Mar 10, 2025 by Vates

Use this data source to filter Xenorchestra hosts by certain criteria (name_label, tags) for use in other resources.

Using getXoaHosts

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 getXoaHosts(args: GetXoaHostsArgs, opts?: InvokeOptions): Promise<GetXoaHostsResult>
function getXoaHostsOutput(args: GetXoaHostsOutputArgs, opts?: InvokeOptions): Output<GetXoaHostsResult>
Copy
def get_xoa_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) -> GetXoaHostsResult
def get_xoa_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[GetXoaHostsResult]
Copy
func GetXoaHosts(ctx *Context, args *GetXoaHostsArgs, opts ...InvokeOption) (*GetXoaHostsResult, error)
func GetXoaHostsOutput(ctx *Context, args *GetXoaHostsOutputArgs, opts ...InvokeOption) GetXoaHostsResultOutput
Copy

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

public static class GetXoaHosts 
{
    public static Task<GetXoaHostsResult> InvokeAsync(GetXoaHostsArgs args, InvokeOptions? opts = null)
    public static Output<GetXoaHostsResult> Invoke(GetXoaHostsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetXoaHostsResult> getXoaHosts(GetXoaHostsArgs args, InvokeOptions options)
public static Output<GetXoaHostsResult> getXoaHosts(GetXoaHostsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: xenorchestra:index/getXoaHosts:getXoaHosts
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

PoolId This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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.

getXoaHosts Result

The following output properties are available:

Hosts List<GetXoaHostsHost>
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 []GetXoaHostsHost
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<GetXoaHostsHost>
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 GetXoaHostsHost[]
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[GetXoaHostsHost]
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

GetXoaHostsHost

Cpus This property is required. 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 This property is required. string
Memory This property is required. int
The memory size of the host.
MemoryUsage This property is required. int
The memory usage of the host.
NameLabel This property is required. string
The name label of the host.
PoolId This property is required. string
Id of the pool that the host belongs to.
Tags List<string>
The tags (labels) applied to the given entity.
Cpus This property is required. 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 This property is required. string
Memory This property is required. int
The memory size of the host.
MemoryUsage This property is required. int
The memory usage of the host.
NameLabel This property is required. string
The name label of the host.
PoolId This property is required. string
Id of the pool that the host belongs to.
Tags []string
The tags (labels) applied to the given entity.
cpus This property is required. 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 This property is required. String
memory This property is required. Integer
The memory size of the host.
memoryUsage This property is required. Integer
The memory usage of the host.
nameLabel This property is required. String
The name label of the host.
poolId This property is required. String
Id of the pool that the host belongs to.
tags List<String>
The tags (labels) applied to the given entity.
cpus This property is required. {[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 This property is required. string
memory This property is required. number
The memory size of the host.
memoryUsage This property is required. number
The memory usage of the host.
nameLabel This property is required. string
The name label of the host.
poolId This property is required. string
Id of the pool that the host belongs to.
tags string[]
The tags (labels) applied to the given entity.
cpus This property is required. 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 This property is required. str
memory This property is required. int
The memory size of the host.
memory_usage This property is required. int
The memory usage of the host.
name_label This property is required. str
The name label of the host.
pool_id This property is required. str
Id of the pool that the host belongs to.
tags Sequence[str]
The tags (labels) applied to the given entity.
cpus This property is required. 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 This property is required. String
memory This property is required. Number
The memory size of the host.
memoryUsage This property is required. Number
The memory usage of the host.
nameLabel This property is required. String
The name label of the host.
poolId This property is required. 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.2 published on Monday, Mar 10, 2025 by Vates