Amazon FSx File System pattern-based discovery
Summarize
Summary of Amazon FSx File System pattern-based discovery
The Amazon FSx File System pattern-based discovery enables ServiceNow customers to find and identify Amazon FSx File Systems within their AWS cloud environments using Discovery and Service Mapping Patterns. This pattern supports comprehensive discovery by populating data in both CMDB and non-CMDB tables, helping maintain accurate and up-to-date configuration information for FSx File Systems.
Show less
Prerequisites and Setup
- Ensure AWS discovery prerequisites are met as outlined in the Amazon AWS Cloud components discovery documentation.
- Verify the FSx File System resource is not listed in the Resource Inclusion List table (sacloudinventoryresourcewhitelist) to avoid duplicate entries.
- The FSx discovery pattern is disabled by default and must be enabled. Starting with Visibility Content version 6.28.0, activating or deactivating patterns no longer counts as a customization and patterns reset to the latest version after upgrades while retaining the last active state.
Data Storage and Tables
Discovery populates two types of tables:
- Non-CMDB tables: Data collected via the Amazon AWS - FSx File System - Extended Inventory (LP) pattern is stored here, accessible under the AWS section in ServiceNow. This includes detailed FSx File System attributes such as ID, ARN, file system type, lifecycle status, owner ID, and DNS name.
- CMDB tables: Key configuration items representing FSx File Systems are stored in the cmdbcicmpresource table, with details like resource type (AWS::FSx::FileSystem), install status, and operational status.
CI Relationships and References
The discovery pattern establishes important relationships to support comprehensive resource mapping:
- CI Relationships: FSx File Systems are linked to AWS Datacenters via a "Hosted on::Hosts" relationship stored in the CMDB.
- CI References: FSx File System records reference related Cloud Resource records to maintain integrity and association between tables.
AWS Tag Discovery
The pattern also gathers AWS tags associated with FSx File Systems and stores them in the cmdbkeyvalue table. These tags include key-value pairs linked back to the corresponding Cloud Resource records, enabling enhanced filtering, reporting, and management based on AWS tagging.
Discovery and Service Mapping Patterns finds Amazon FSx File Systems 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.
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 - FSx File System - 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] | The ID of the file system, used as the display name. |
| Object ID [object_id] | The Amazon Resource Name (ARN) of the file system. |
| File System Id [file_system_id] | The ID of the file system. |
| File System Type [file_system_type] | The type of file system. For example: WINDOWS, LUSTRE, ONTAP, or OPENZFS. |
| File System Type Version [file_system_type_version] | The version of the file system type. |
| Lifecycle [lifecycle] | The lifecycle status of the file system. For example: AVAILABLE, CREATING, DELETING, FAILED, MISCONFIGURED, or UPDATING. |
| Owner Id [owner_id] | The ID of the AWS account that owns the file system. |
| DNS Name [dns_name] | The Domain Name System (DNS) name for the file system. |
| Configuration Item [configuration_item] | References the Cloud Resource [cmdb_ci_cmp_resource] table. |
Data stored in CMDB tables
Discovery and Service Mapping Patterns application populates data in the CMDB when running the Amazon AWS - FSx File System - Extended Inventory (LP) pattern.
| Field | Description |
|---|---|
| Name [name] | The ID of the file system, used as the display name. |
| Object ID [object_id] | The ARN of the file system. |
| Resource type [resource_type] | Type of resource. The value is set to AWS::FSx::FileSystem. |
| 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 - FSx File System - Extended Inventory (LP) pattern creates the following relationships and references to support Amazon FSx File System discovery. References link to records in other tables and don't appear in the CI Relationship [cmdb_rel_ci] table.
| CI | Relationship | CI |
|---|---|---|
| Cloud Resource [cmdb_ci_cmp_resource] | Hosted on::Hosts | AWS Datacenter [cmdb_ci_aws_datacenter] |
| CI | Field | Referenced CI |
|---|---|---|
| AWS FSx File System [cmdb_aws_fsx_file_system] | Configuration Item [configuration_item] | Cloud Resource [cmdb_ci_cmp_resource] |
| Key Value [cmdb_key_value] | Configuration item [configuration_item] | Cloud Resource [cmdb_ci_cmp_resource] |
AWS Tag discovery
The Amazon AWS - FSx File System - 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 Resource [cmdb_ci_cmp_resource] table. |