account_id |
Account ID
Optional identifier for account based on which virtual machines are to
be filtered
|
string |
|
agent_status |
Agent Status
UP - NSX Agent is up and running
DOWN - NSX Agent is down
NO_AGENT - No NSX Agent installed on VM
UNKNOWN - NSX Agent status is unknown
UPDATE_AVAILABLE - NSX Tools can be upgraded to a newer version that's available
NEEDS_UPDATE - NSX Tools running on the VM needs to be updated for proper functioning
|
string |
Readonly Enum: UP, DOWN, NO_AGENT, UNKNOWN, UPDATE_AVAILABLE, NEEDS_UPDATE |
cloud_security_group_id |
Security Group ID
Optional identifier to limit results of VMs associated with the
provided cloud security group. For AWS, provide the group id.
For Azure, provide the resourceGuid of the Azure security group.
|
string |
Readonly |
cloud_type |
Cloud Type
Optional identifier for cloud provider based on which Virtual Machines
are to be filtered
|
string |
Enum: AWS, AZURE |
cursor |
Opaque cursor to be used for getting next page of records (supplied by current result page) |
string |
|
included_fields |
Comma separated list of fields that should be included in query result |
string |
|
instance_id |
Instance ID
Optional identifier for virtual machine based on which the list can be
filtered
|
string |
|
is_gateway |
Is the VM a gateway node?
Optional identifier based on which only gateway Virtual Machines can be
filtered
|
boolean |
|
logical_switch_id |
Logical Switch ID
Optional identifier for logical switch based on which Aws Virtual
Machines are to be filtered
|
string |
|
page_size |
Maximum number of results to return in this page (server may return fewer) |
integer |
Minimum: 0 Maximum: 1000 Default: "1000" |
public_ip |
Public IP address of the virtual machine
Optional identifier for public IP based on which Virtual Machines are
to be filtered
|
string |
|
quarantine_state |
Quarantine State
Identifier for quarantine state based on which Virtual Machines are to
be filtered.
QUARANTINED - This state implies VM is moved to quarantine security
group because some threat has been detected.
NOT_QUARANTINED - This state implies no quarantine action has been
taken.
UNKNOWN - This state implies either quarantine policy is disabled or
quarantine information is not available.
OVERRIDDEN - This state implies VM is associated with vm_override_sg
which overrides any action based on threat detection.
|
string |
Readonly Enum: QUARANTINED, NOT_QUARANTINED, UNKNOWN, OVERRIDDEN |
region_id |
Region ID
Optional identifier for AWS or Azure region based on which Virtual
Machines are to be filtered
|
string |
|
resource_type |
Resource Type
Optional identifier for listing virtual machines of a particular cloud
provider. Possible values are in the form of VirtualMachine prefixed by
cloud name. For example, AwsVirtualMachine or AzureVirtualMachine.
|
string |
Enum: AwsVirtualMachine, AzureVirtualMachine |
segment_id |
Segment ID
Optional identifier for segment based on which Virtual Machines are to
be filtered.
|
string |
|
sort_ascending |
|
boolean |
|
sort_by |
Field by which records are sorted |
string |
|
status_filter |
Filter by Virtual machine status
POWERED_OFF - Powered off instances.
MANAGED - Instances that are managed by NSX or tagged.
UNMANAGED - Instances that are not managed by NSX or untagged.
ERRORED - Instances with no NSX Tools connectivity, NSX Tools is down,
No NSX Policy configured for Native cloud security enforced instances or
Error on NSX Policy rule realization.
WHITELISTED - Instances which have been whitelisted.
QUARANTINED - Instances that have been quarantined because some
threat has been detected.
NEEDS_UPDATE - NSX Tools running on instance is out of date and needs to be updated.
HORIZON_VDI - Instances on Microsoft Azure that are part of the Horizon Cloud Services (HCS).
|
string |
Readonly Enum: POWERED_OFF, MANAGED, UNMANAGED, ERRORED, WHITELISTED, QUARANTINED, NEEDS_UPDATE, HORIZON_VDI |
vnet_id |
Azure virtual network ID
Optional identifier for Azure virtual network based on which Azure
Virtual Machines are to be filtered. It consists of resourceGuid of Azure Vnet.
|
string |
|
vpc_id |
AWS VPC ID
Optional identifier for AWS VPC based on which Virtual Machines are to
be filtered
|
string |
|