AWS Storage Gateway Gateway pattern-based discovery
Summarize
Summary of AWS Storage Gateway Gateway pattern-based discovery
The AWS Storage Gateway Gateway pattern-based discovery enables ServiceNow customers to identify and map AWS Storage Gateway resources within their cloud environments using the Discovery and Service Mapping Patterns application. This process helps populate critical asset and configuration data into both CMDB and non-CMDB tables, enhancing visibility and management of AWS Storage Gateway Gateways.
Show less
Key Features
- Pattern Activation: The Storage Gateway discovery pattern is disabled by default. Starting with Visibility Content version 6.28.0, enabling or disabling patterns does not count as customization and updates are preserved after upgrades.
- Discovery Prerequisites: Customers must verify AWS discovery prerequisites and ensure resources are not duplicated by removing entries from the Resource Inclusion List table.
- GovCloud Support: Special configuration involving datacenter URLs is required when discovering AWS GovCloud (US) accounts.
- Data Population: The discovery process populates data in both CMDB tables (e.g., Cloud Gateway [cmdbcicloudgateway]) and non-CMDB tables (e.g., AWS Storage Gateway Gateway [cmdbawsstoragegatewaygateway]), allowing comprehensive asset tracking.
- CI Relationships and References: Relationships such as “Hosted on” link the Cloud Gateway CI to AWS Datacenter CIs, supporting accurate configuration management.
- AWS Tag Collection: Discovered tags are stored in the Key Value [cmdbkeyvalue] table, linked to the Cloud Gateway CIs, facilitating tag-based organization and reporting.
Key Outcomes
- Enables automated discovery and mapping of AWS Storage Gateway Gateways, contributing to a more accurate and up-to-date CMDB.
- Supports operational insights by capturing gateway details such as type, state, environment, and identifiers.
- Improves configuration management through established relationships between gateways and AWS datacenters.
- Facilitates governance and operational efficiency by incorporating AWS tags into the CMDB data model.
- Ensures seamless pattern updates without customization conflicts, maintaining up-to-date discovery capabilities.
Discovery and Service Mapping Patterns finds AWS Storage Gateway Gateways on your cloud environment. Discovering some of these resources may require updating to the latest version of the Discovery and Service Mapping Patterns application from the ServiceNow Store.
Pattern-based discovery and mapping requirements
- Verify the AWS discovery prerequisites
- For more information, see the prerequisites section in Amazon AWS Cloud components discovery using patterns.
- Remove resources from the Resource Inclusion List table
- Verify that the relevant resource isn't listed in the Resource Inclusion List [sa_cloud_inventory_resource_whitelist] table to avoid duplicate discovery. For more information on removing resources from the Resource Inclusion List, see Amazon Web Services (AWS) Resource Inventory.
- Enable the relevant pattern
- The pattern for this service is disabled by default. Starting with Visibility Content version 6.28.0, activating or deactivating a pattern won't be considered a customization, and it will continue to receive updates. Patterns that were previously activated or deactivated will reset to the latest predefined version after upgrading while retaining the last active field value. For more information on enabling patterns, see Activate a disabled pattern.
- Configure the Discovery schedule to support GovCloud
- Discovering AWS GovCloud (US) accounts requires using a datacenter URL when setting up an AWS service account. For more information, see Create AWS service accounts.
Discovery and Service Mapping Patterns application populates data in both CMDB and non-CMDB tables.
Data stored in non-CMDB tables
Discovery and Service Mapping Patterns application populates data in the non-CMDB table when running the Amazon AWS - Storage Gateway Gateway - Extended Inventory (LP) pattern.
You can review the non-CMDB AWS tables by navigating to . You can also search the navigation filter for the specific pattern name.
| Field | Description |
|---|---|
| Name [name] | Name of the gateway. |
| Object ID [object_id] | The Amazon Resource Name (ARN) of the gateway. |
| Gateway ID [gateway_id] | The unique identifier of the gateway. |
| Gateway Type [gateway_type] | The type of the gateway. For example: STORED, CACHED, VTL, FILE_S3, or FILE_FSX_SMB. |
| Gateway State [gateway_state] | The current state of the gateway. The value is RUNNING or SHUTDOWN. |
| Host Environment [host_environment] | The host environment in which the gateway is running. For example: EC2, VMWARE, HYPER-V, KVM, SNOWBALL, or OTHER. |
| Configuration Item [configuration_item] | References the Cloud Gateway [cmdb_ci_cloud_gateway] table. |
Data stored in CMDB tables
Discovery and Service Mapping Patterns application populates data in the CMDB when running the Amazon AWS - Storage Gateway Gateway - Extended Inventory (LP) pattern.
| Field | Description |
|---|---|
| Name [name] | Name of the gateway. |
| Object ID [object_id] | The ARN of the gateway. |
| Environment [environment] | The host environment in which the gateway is running. For example: EC2, VMWARE, HYPER-V, KVM, SNOWBALL, or OTHER. |
| Description [short_description] | Type of resource. The value is set to AWS::StorageGateway::Gateway. |
| Install Status [install_status] | Install status of the resource. Default value is Installed. |
| Operational status [operational_status] | Operational status of the resource. Default value is Operational. |
CI relationships
The Amazon AWS - Storage Gateway Gateway - Extended Inventory (LP) pattern creates the following relationships and references to support AWS Storage Gateway Gateway discovery. References link to records in other tables and don't appear in the CI Relationship [cmdb_rel_ci] table.
| CI | Relationship | CI |
|---|---|---|
| Cloud Gateway [cmdb_ci_cloud_gateway] | Hosted on::Hosts | AWS Datacenter [cmdb_ci_aws_datacenter] |
| CI | Field | Referenced CI |
|---|---|---|
| AWS Storage Gateway Gateway [cmdb_aws_storage_gateway_gateway] | Configuration Item [configuration_item] | Cloud Gateway [cmdb_ci_cloud_gateway] |
| Key Value [cmdb_key_value] | Configuration item [configuration_item] | Cloud Gateway [cmdb_ci_cloud_gateway] |
AWS Tag discovery
The Amazon AWS - Storage Gateway Gateway - Extended Inventory (LP) pattern collects tags and populates them in the Key Value [cmdb_key_value] table.
| Field | Description |
|---|---|
| Key [key] | Tag name. |
| Value [value] | Tag value. |
| Configuration item [configuration_item] | References the Cloud Gateway [cmdb_ci_cloud_gateway] table. |