The Automation API is now available. No CLI. No human-in-the-loop. Just your code. Learn More

GetInstances

Using GetInstances

function getInstances(args: GetInstancesArgs, opts?: InvokeOptions): Promise<GetInstancesResult>
def get_instances(filters: Optional[Sequence[GetInstancesFilterArgs]] = None, sorts: Optional[Sequence[GetInstancesSortArgs]] = None, opts: Optional[InvokeOptions] = None) -> GetInstancesResult
func GetInstances(ctx *Context, args *GetInstancesArgs, opts ...InvokeOption) (*GetInstancesResult, error)
public static class GetInstances {
    public static Task<GetInstancesResult> InvokeAsync(GetInstancesArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Filters List<GetInstancesFilterArgs>

Filter the results. The filter block is documented below.

Sorts List<GetInstancesSortArgs>

Sort the results. The sort block is documented below.

Filters []GetInstancesFilter

Filter the results. The filter block is documented below.

Sorts []GetInstancesSort

Sort the results. The sort block is documented below.

filters GetInstancesFilter[]

Filter the results. The filter block is documented below.

sorts GetInstancesSort[]

Sort the results. The sort block is documented below.

filters Sequence[GetInstancesFilterArgs]

Filter the results. The filter block is documented below.

sorts Sequence[GetInstancesSortArgs]

Sort the results. The sort block is documented below.

GetInstances Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

Instances List<GetInstancesInstance>

A list of Instances satisfying any filter and sort criteria. Each instance has the following attributes:

Filters List<GetInstancesFilter>
Sorts List<GetInstancesSort>
Id string

The provider-assigned unique ID for this managed resource.

Instances []GetInstancesInstance

A list of Instances satisfying any filter and sort criteria. Each instance has the following attributes:

Filters []GetInstancesFilter
Sorts []GetInstancesSort
id string

The provider-assigned unique ID for this managed resource.

instances GetInstancesInstance[]

A list of Instances satisfying any filter and sort criteria. Each instance has the following attributes:

filters GetInstancesFilter[]
sorts GetInstancesSort[]
id str

The provider-assigned unique ID for this managed resource.

instances Sequence[GetInstancesInstance]

A list of Instances satisfying any filter and sort criteria. Each instance has the following attributes:

filters Sequence[GetInstancesFilter]
sorts Sequence[GetInstancesSort]

Supporting Types

GetInstancesFilter

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Key string

Filter the Instances by this key. This may be one of ‘id, hostname, public_ip, private_ip, pseudo_ip, size, cpu_cores, ram_mb, disk_gb, template or created_at.

Values List<string>

A list of values to match against the key field. Only retrieves Instances where the key field takes on one or more of the values provided here.

Key string

Filter the Instances by this key. This may be one of ‘id, hostname, public_ip, private_ip, pseudo_ip, size, cpu_cores, ram_mb, disk_gb, template or created_at.

Values []string

A list of values to match against the key field. Only retrieves Instances where the key field takes on one or more of the values provided here.

key string

Filter the Instances by this key. This may be one of ‘id, hostname, public_ip, private_ip, pseudo_ip, size, cpu_cores, ram_mb, disk_gb, template or created_at.

values string[]

A list of values to match against the key field. Only retrieves Instances where the key field takes on one or more of the values provided here.

key str

Filter the Instances by this key. This may be one of ‘id, hostname, public_ip, private_ip, pseudo_ip, size, cpu_cores, ram_mb, disk_gb, template or created_at.

values Sequence[str]

A list of values to match against the key field. Only retrieves Instances where the key field takes on one or more of the values provided here.

GetInstancesInstance

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

CpuCores int

Total cpu of the inatance.

CreatedAt string

The date of creation of the instance

DiskGb int

The size of the disk.

FirewallId string

The ID of the firewall used.

Hostname string

The Instance hostname.

Id string

The ID of the Instance.

InitialPassword string

Instance initial password

InitialUser string

The name of the initial user created on the server.

NetworkId string

This will be the ID of the network.

Notes string

The notes of the instance.

PrivateIp string

The private ip.

PseudoIp string

Is the ip that is used to route the public ip from the internet to the instance using NAT

PublicIp string

The public ip.

RamMb int

Total ram of the instance.

ReverseDns string

A fully qualified domain name.

Script string

the contents of a script uploaded

Size string

The name of the size.

SshkeyId string

The ID SSH.

Status string

The status of the instance

Tags List<string>

An optional list of tags

Template string

The ID for the template to used to build the instance.

CpuCores int

Total cpu of the inatance.

CreatedAt string

The date of creation of the instance

DiskGb int

The size of the disk.

FirewallId string

The ID of the firewall used.

Hostname string

The Instance hostname.

Id string

The ID of the Instance.

InitialPassword string

Instance initial password

InitialUser string

The name of the initial user created on the server.

NetworkId string

This will be the ID of the network.

Notes string

The notes of the instance.

PrivateIp string

The private ip.

PseudoIp string

Is the ip that is used to route the public ip from the internet to the instance using NAT

PublicIp string

The public ip.

RamMb int

Total ram of the instance.

ReverseDns string

A fully qualified domain name.

Script string

the contents of a script uploaded

Size string

The name of the size.

SshkeyId string

The ID SSH.

Status string

The status of the instance

Tags []string

An optional list of tags

Template string

The ID for the template to used to build the instance.

cpuCores number

Total cpu of the inatance.

createdAt string

The date of creation of the instance

diskGb number

The size of the disk.

firewallId string

The ID of the firewall used.

hostname string

The Instance hostname.

id string

The ID of the Instance.

initialPassword string

Instance initial password

initialUser string

The name of the initial user created on the server.

networkId string

This will be the ID of the network.

notes string

The notes of the instance.

privateIp string

The private ip.

pseudoIp string

Is the ip that is used to route the public ip from the internet to the instance using NAT

publicIp string

The public ip.

ramMb number

Total ram of the instance.

reverseDns string

A fully qualified domain name.

script string

the contents of a script uploaded

size string

The name of the size.

sshkeyId string

The ID SSH.

status string

The status of the instance

tags string[]

An optional list of tags

template string

The ID for the template to used to build the instance.

cpu_cores int

Total cpu of the inatance.

created_at str

The date of creation of the instance

disk_gb int

The size of the disk.

firewall_id str

The ID of the firewall used.

hostname str

The Instance hostname.

id str

The ID of the Instance.

initial_password str

Instance initial password

initial_user str

The name of the initial user created on the server.

network_id str

This will be the ID of the network.

notes str

The notes of the instance.

private_ip str

The private ip.

pseudo_ip str

Is the ip that is used to route the public ip from the internet to the instance using NAT

public_ip str

The public ip.

ram_mb int

Total ram of the instance.

reverse_dns str

A fully qualified domain name.

script str

the contents of a script uploaded

size str

The name of the size.

sshkey_id str

The ID SSH.

status str

The status of the instance

tags Sequence[str]

An optional list of tags

template str

The ID for the template to used to build the instance.

GetInstancesSort

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Key string

Sort the Instance by this key. This may be one of id, hostname, public_ip, private_ip, pseudo_ip, size, cpu_cores, ram_mb, disk_gb, template or created_at.

Direction string

The sort direction. This may be either asc or desc.

Key string

Sort the Instance by this key. This may be one of id, hostname, public_ip, private_ip, pseudo_ip, size, cpu_cores, ram_mb, disk_gb, template or created_at.

Direction string

The sort direction. This may be either asc or desc.

key string

Sort the Instance by this key. This may be one of id, hostname, public_ip, private_ip, pseudo_ip, size, cpu_cores, ram_mb, disk_gb, template or created_at.

direction string

The sort direction. This may be either asc or desc.

key str

Sort the Instance by this key. This may be one of id, hostname, public_ip, private_ip, pseudo_ip, size, cpu_cores, ram_mb, disk_gb, template or created_at.

direction str

The sort direction. This may be either asc or desc.

Package Details

Repository
https://github.com/pulumi/pulumi-civo
License
Apache-2.0
Notes
This Pulumi package is based on the civo Terraform Provider.