Aws Virtual Machine Information
Stores information about a AWS Virtual Machine
Name | Description | Type | Notes |
---|---|---|---|
_create_time | Timestamp of resource creation | EpochMsTimestamp | Readonly Sortable |
_create_user | ID of the user who created this resource | string | Readonly |
_last_modified_time | Timestamp of last modification | EpochMsTimestamp | Readonly Sortable |
_last_modified_user | ID of the user who last modified this resource | string | Readonly |
_links | References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST. |
array of ResourceLink | Readonly |
_protection | Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. |
string | Readonly |
_revision | Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. |
int | |
_schema | Schema for this resource | string | Readonly |
_self | Link to this resource | SelfResourceLink | Readonly |
_system_owned | Indicates system owned resource | boolean | Readonly |
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 |
string | Readonly Enum: UP, DOWN, NO_AGENT, UNKNOWN |
agent_version | Agent version details | string | Readonly |
associated_account_ids | Associated Cloud Account IDs Array of associated cloud account IDs. |
array of string | |
availability_zone | AWS Availability Zone AWS availability zone in which virtual machine is residing |
string | Readonly |
cloud_instance_type | Cloud Instance Type This field represents various type of service instances in cloud. VIRTUAL_MACHINE: Virtual machine deployed in public cloud. AWS_RDS_INSTANCE: Amazon Relational Database Service Instance. AWS_RDS_CLUSTER: Amazon Relational Database Service Cluster. AWS_APPLICATION_ELB_INSTANCE: Amazon Application Elastic LoadBalancer. AWS_CLASSIC_ELB_INSTANCE: Amazon Classic Elastic LoadBalancer. |
string | Readonly Enum: VIRTUAL_MACHINE, AWS_RDS_INSTANCE, AWS_RDS_CLUSTER, AWS_APPLICATION_ELB_INSTANCE, AWS_CLASSIC_ELB_INSTANCE |
cloud_tags | Cloud tags for the virtual machine | array of CloudTag | Readonly |
description | Description of this resource | string | Maximum length: 1024 Sortable |
display_name | Identifier to use when displaying entity in logs or GUI Defaults to ID if not set |
string | Maximum length: 255 Sortable |
error_messages | List of error messages List of error messages identified. Returns only error messages identified in the last 1 hour. |
array of ComputeInstanceErrorMessage | Readonly |
gateway_ha_index | Gateway HA Index Index of HA that indicates whether gateway is primary or secondary. If index is 0, then it is primary gateway. Else secondary gateway. |
integer | |
gateway_status | Gateway Status | string | Readonly Enum: UP, DOWN, DEPLOYING, NOT_AVAILABLE, UNDEPLOYING |
id | Unique identifier of this resource | string | Sortable |
is_gateway | Flag to identify if this VM is a gateway node | boolean | Readonly |
is_gateway_active | Flag to identify if this VM is an active gateway node | boolean | Readonly |
logical_switch_display_name | Logical Switch display name | string | Readonly |
logical_switch_id | Logical Switch ID | string | Readonly |
managed_by_nsx | Indicate if vm is managed by NSX or not | boolean | Required Readonly |
nsx_failed_rules_count | NSX failed rules count Number of NSX firewall rules failed to realize on cloud for the VM. |
integer | Readonly |
nsx_ip | IP address provided by NSX | string | Readonly |
nsx_security_group_mapping | NSX Security Group Mapping Map of cloud security groups associated to the virtual machine and corresponding NSX security groups. |
array of SecurityGroupDetails | Readonly |
nsx_security_rule_errors | NSX Security Rule Errors DEPRECATED. Array of NSX security rule realization errors. To get this information call /csm/virtual-machines/ |
array of NsxSecurityRuleErrorDetails | Deprecated Readonly |
nsx_security_rule_errors_count | NSX Security Rule Errors Count DEPRECATED. Count of the NSX security rule realization errors. To get this information call /csm/virtual-machines/ |
integer | Deprecated Readonly |
nsx_successful_rules_count | NSX successful rules count Number of NSX firewall rules successfully configured for this VM. |
integer | Readonly |
os_details | Operating system details | string | Readonly |
os_type | Operating system of the virtual machine | string | Readonly |
power_state | Power State Indicates the power state of the virtual machine as returned by AWS. |
string | Readonly Enum: PENDING, RUNNING, SHUTTING_DOWN, TERMINATED, STOPPING, STOPPED |
private_ip | Private IP address of the virtual machine | string | Readonly |
public_ip | Public IP address of the virtual machine | string | Readonly |
quarantine_state | Quarantine State Indicates the quarantine state of the VM. 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. WHITELISTED - This state implies that quarantine operation will not be performed on the VM. NOT_APPLICABLE - This state will be populated for agentless vm. |
string | Readonly Enum: QUARANTINED, NOT_QUARANTINED, UNKNOWN, OVERRIDDEN, WHITELISTED, NOT_APPLICABLE |
region | AWS Region AWS region in which virtual machine is residing |
string | Readonly |
resource_type | Must be set to the value AwsVirtualMachine | string | Required Enum: AwsVirtualMachine, AzureVirtualMachine |
segment_display_name | Segment display name Segment display name on which this VM resides. |
string | Readonly |
segment_id | Segment ID Segment ID on which this VM resides. |
string | Readonly |
tags | Opaque identifiers meaningful to the API user | array of Tag | Maximum items: 30 |
threat_state | Threat State Indicates the threat state of the VM. NORMAL - This state implies no threat has been detected and VM is functioning as expected. THREAT - This state implies quarantine enabling threat has been detected. INVALID - This state implies either VM is unmanaged or threat related information is not available. NOT_APPLICABLE - This state will be populated for agentless vm. |
string | Readonly Enum: NORMAL, THREAT, INVALID, NOT_APPLICABLE |
vm_config_status | Status for user configurable properties | VmConfigStatus | Readonly |
vm_extension_execution_status | VM extension script execution status UNKNOWN - This is the default state. Indicates no information available regarding extension execution. This can potentially occur for a VM when agent is installed out of band or if cloud_agent_automated_install_enabled flag is enabled for the VNET/VPC which already has managed VMs. SUCCESSFUL - Indicates VM extension script execution was successful. This does not necessarily mean agent installation was successful. FAILED - Indicates VM extension script execution failed. |
string | Readonly |
vpc | AWS VPC AWS VPC ID in which virtual machine is residing |
string | Readonly |
vpc_name | AWS VPC name AWS VPC name in which virtual machine is residing |
string | Readonly |