Service Graph Connector for AWS - Functional Spec and CI
Functional Requirements
Functional requirements are broadly classified into two categories: Hardware and Software. To pull CI information from AWS, follow the three data pull strategies below:
Baseline
- This is fresh import of data from AWS into the CMDB CI Database.
- After importing, we will record the time of import, this will be the input for the incremental pull.
Incremental Update/Delta:
- Delta or Incremental update will pull the resource data which was updated or created after the last pull.
Deletion
- We will identify the resource as deleted and perform the operation based on the hardware or software type.
Discovered Hardware CIs
| # | Class Name | CI Name | API Source |
|---|---|---|---|
| 1 | Cloud Organizations | cmdb_ci_cloud_org | Organizations |
| 2 | Cloud Service Account | cmdb_ci_cloud_service_account | Organizations |
| 3 | Logical Datacenter | cmdb_ci_logical_datacenter | EC2 |
| 4 | Availability Zone | cmdb_ci_availability_zone | AWS Config |
| 5 | Cloud Network | cmdb_ci_network | AWS Config |
| 6 | Cloud Subnet | cmdb_ci_cloud_subnet | AWS Config |
| 7 | Cloud Mgmt Network Interface | cmdb_ci_nic | AWS Config |
| 8 | Hardware Type | cmdb_ci_compute_template | AWS Config |
| 9 | Compute Security Group | cmdb_ci_compute_security_group | AWS Config |
| 10 | Image | cmdb_ci_os_template | AWS Config |
| 11 | Storage Volume | cmdb_ci_storage_volume | AWS Config |
| 12 | Cloud Load Balancer | cmdb_ci_cloud_load_balancer | AWS Config |
| 13 | Cloud Gateway | cmdb_ci_cloud_gateway | AWS Config |
| 14 | Virtual Machine Instance | cmdb_ci_vm_instance | AWS Config |
| 15 | Server | cmdb_ci_server cmdb_ci_linux_server cmdb_ci_win_server | AWS Config |
| 16 | Cloud DataBase | cmdb_ci_cloud_database | AWS Config |
| 17 | Cloud Function | cmdb_ci_cloud_function | AWS Config |
| 18 | Cloud Object Storage | cmdb_ci_cloud_object_storage | AWS Config |
| 19 | DynamoDB Table | cmdb_ci_dynamodb_table | AWS Config |
| 20 | IP Address | cmdb_ci_ip_address | AWS Config |
| 21 | Network Adapter | cmdb_ci_network_adapter | AWS Config |
| 22 | TCP | cmdb_tcp | SSM Send Command & ADM process |
| 23 | Running Process | cmdb_running_process | SSM Send Command & ADM process |
| 24 | VNIC Endpoint | cmdb_ci_endpoint_vnic | AWS Config |
| 25 | Storage Mapping | cmdb_ci_storage_mapping | AWS Config |
| 26 | Block Endpoint | cmdb_ci_endpoint_block | AWS Config |
| 27 | Key Value | cmdb_key_value | AWS Config |
| 28 | Application | cmdb_ci_appl | SSM Send Command & ADM process |
Discovered Software CIs
| SAM Plugin | Class Name | CI Name | API Source |
|---|---|---|---|
| Installed | Software Install | cmdb_sam_sw_install | SSM & AWS Config |
| Not Installed | Software Package | cmdb_ci_spkg | |
| Not Installed | Software Instance | cmdb_software_instance |
Consolidated view of CIs
Detailed CI Information
Cloud Organizations [cmdb_ci_cloud_org]
Cloud Service Account [cmdb_ci_cloud_service_account]
| Account Id | |
|---|---|
| Name | |
| Datacenter Type | |
| Parent Account | |
| Is master Account | |
| Data Source | SG-AWS |
Logical Datacenter [cmdb_ci_logical_datacenter]
Availability Zone [cmdb_ci_availability_zone]
Cloud Network [cmdb_ci_network]
| Name | | |
| ------------- | ------------------------------------------------------------- | |
| Object ID | | |
| Status | Installed | |
| Data Source | SG-AWS | |
| Related Items | Availability Zones Cloud Service Accounts Logical Datacenters | |
Cloud Subnet [cmdb_ci_cloud_subnet]
| Name | |
|---|---|
| State | Available |
| Object ID | |
| CIDR | |
| Status | Installed |
| Data Source | SG-AWS |
| Related Items | Availability Zones Cloud Service Accounts Logical Datacenters Key-Value |
Cloud Mgmt Network Interface [cmdb_ci_nic]
| Name | |
|---|---|
| Netmask | |
| Status | Installed |
| Related Items | Availability Zones Cloud Service Accounts Logical Datacenters Key-Value |
| Data Source | SG-AWS |
Hardware Type [cmdb_ci_compute_template]
| Name | |
|---|---|
| vCPUs | |
| Memory MB | |
| Logical Storage GB | |
| Data Source | SG-AWS |
Compute Security Group [cmdb_ci_compute_security_group]
| Name | |
|---|---|
| ObjectID | |
| State | Available |
| Related Items | Cloud Networks Availability Zones Cloud Service Accounts Logical Datacenters Key-Value |
| Data Source | SG-AWS |
Image [cmdb_ci_os_template]
| Name | |
|---|---|
| ObjectID | |
| Guest OS | |
| Root Device Type | |
| Image Type | |
| Image Source | |
| Data Source | SG-AWS |
Storage Volume [cmdb_ci_storage_volume]
| Name | |
|---|---|
| ObjectID | |
| State | Available/In Use/Terminated/Leased |
| Size | |
| Storage Type | |
| Related Items | Availability Zones Cloud Service Accounts Logical Datacenters Key-Value |
| Data Source | SG-AWS |
Cloud Load Balancer [cmdb_ci_cloud_load_balancer]
| Name | |
|---|---|
| ObjectID | |
| Related Items | Cloud Load Balancers Availability Zones Cloud Service Accounts Logical Datacenters Compute Security groups Virtual Machine Instances Cloud Object Storages Images Hardware Types Cloud Gateways Storage Volume Snapshots Storage Volumes Cloud Networks Cloud Databases DynamoDB Tables Cloud Mgmt Network Interfaces Key-Value |
| Data Source | SG-AWS |
Cloud Gateway [cmdb_ci_cloud_gateway]
| Name | |
|---|---|
| Related Items | Availability Zones Cloud Service Accounts Logical Datacenters |
| Data Source | SG-AWS |
Virtual Machine Instance [cmdb_ci_vm_instance]
| Name | |
|---|---|
| ObjectID | |
| Disks | |
| Network adapters | |
| IP Address | |
| VM Instance ID | |
| Related Items | Availability ZonesCloud Service Accounts Logical Datacenters Images Hardware Types Servers Key-Value Webservers SQL Instances |
| Data Source | SG-AWS |
Server
[cmdb_ci_linux_server, cmdb_ci_win_server or cmdb_ci_server*]**
| Name | |
|---|---|
| Operating System | |
| Serial Number | |
| DNS Domain | |
| Disk Space (GB) | |
| RAM (MB) | |
| CPU Speed(MHz) | |
| CPU count | |
| CPU core count | |
| Manufacturer | |
| Model ID | |
| CPU Manufacturer | |
| CPU Type | |
| CPU Speed (MHz) | |
| CPU Core count | |
| Operating System | |
| OS Version | |
| Related Items | Availability ZonesCloud Service Accounts Logical Datacenters Images Hardware Types Webservers SQL Instances Block Endpoints Virtual Machines Key-Value |
| Data Source | SG-AWS |
If SSM is enabled, SGC-AWS can populate the server records in cmdb_ci_linux_server, cmdb_ci_win_server. Else it will be populated in cmdb_ci_server.
Cloud DataBase [cmdb_ci_cloud_database]
| Name | |
|---|---|
| TCP port | |
| Fully qualified domain name | |
| Version | |
| Type | |
| Related Items | Availability ZonesCloud Service Accounts Logical Datacenters Key-Value |
| Data Source | SG-AWS |
Cloud Function [cmdb_ci_cloud_function]
| Name | |
|---|---|
| Language | |
| Version | |
| State | |
| Function Last Modified | |
| Code Size | |
| CodeSha256 | |
| Related Items | Availability ZonesCloud Service Accounts Logical Datacenters Key-Value |
| Data Source | SG-AWS |
Cloud Object Storage [cmdb_ci_cloud_object_storage]
| Name | |
|---|---|
| Related Items | Availability ZonesCloud Service Accounts Logical Datacenters Key-Value |
| Data Source | SG-AWS |
DynamoDB Table [cmdb_ci_dynamodb_table]
| Name | |
|---|---|
| Related Items | Availability ZonesCloud Service Accounts Logical Datacenters Key-Value |
| Data Source | SG-AWS |
IP Address [cmdb_ci_ip_address]
| Name | |
|---|---|
| IP version | |
| Nic | |
| Configuration Item | |
| Data Source | SG-AWS |
Network Adapter [cmdb_ci_network_adapter]
| Name | |
|---|---|
| MAC Address | |
| IP Address | |
| Configuration Item | |
| Data Source | SG-AWS |
TCP [cmdb_tcp]
Source of API: Comes from SSM-SendCommand API script. Click here to view the OS commands executed to get this detail.
| Type | |
|---|---|
| IP | |
| Port | |
| PID | |
| Absent | false/true |
| Data Source | SG-AWS |
Running Process [cmdb_running_process]
Source of API: Comes from SSM-SendCommand API script. Click here to view the OS commands executed to get this detail.
| PID | |
|---|---|
| Name | |
| Command | |
| Parameters | |
| Key parameters | |
| PPID | |
| Parent | |
| Connecting to | |
| Listening on | |
| Computer | |
| Absent | false/true |
| Data Source | SG-AWS |
VNIC Endpoint [cmdb_ci_endpoint_vnic]
| Name | |
|---|---|
| Host | |
| Object ID | |
| Data Source | SG-AWS |
Storage Mapping [cmdb_ci_storage_mapping]
| Name | |
|---|---|
| ObjectID | |
| Mount Point | |
| Data Source | SG-AWS |
Block Endpoint [cmdb_ci_endpoint_block]
| Name | |
|---|---|
| Host | |
| Object ID | |
| Data Source | SG-AWS |
Key Value [cmdb_key_value]
| Configuration Item | |
| ------------------ | |
| Key | |
| Value | |
Related Articles:
https://www.servicenow.com/community/cmdb-articles/service-graph-connector-for-aws-functional-spec-and-ci/ta-p/2301845