CloudVirtualMachinesListRequestParameters (schema)

Cloud Virtual Machines List Request Parameters

A set of optional filter parameters to list cloud virtual machines
Name Description Type Notes
account_id Account ID

Optional identifier for account based on which virtual machines are to
be filtered
string
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
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