Amazon FSx File System pattern-based discovery
Summarize
Summary of Amazon FSx File System pattern-based discovery
This pattern-based discovery enables ServiceNow customers to automatically find and map Amazon FSx File Systems within their AWS cloud environments. It integrates with the Discovery and Service Mapping Patterns application, which must be kept up to date for optimal performance. This discovery populates detailed data into both CMDB and non-CMDB tables, facilitating comprehensive visibility and management of FSx resources.
Show less
Key Features
- Pattern Activation: The FSx File System discovery pattern is disabled by default and requires enabling. Starting with Visibility Content version 6.28.0, activating or deactivating patterns retains update capability and resets to the latest predefined version after upgrades.
- Resource Inclusion List Management: To prevent duplicate discovery, ensure FSx resources are not listed in the Resource Inclusion List [sacloudinventoryresourcewhitelist] table before running discovery.
- Data Population: Discovery populates information into two main tables:
- Non-CMDB Table: The [cmdbawsfsxfilesystem] table stores detailed FSx-specific attributes such as file system ID, type, version, lifecycle status, owner ID, and DNS name.
- CMDB Table: The [cmdbcicmpresource] table records the FSx resource as a cloud resource with fields like resource type (AWS::FSx::FileSystem), install status, and operational status.
- CI Relationships and References: The pattern creates relationships such as “Hosted on” linking FSx resources to AWS Datacenters, and references between configuration items to maintain data integrity and context.
- AWS Tag Discovery: Tags associated with FSx File Systems are collected and stored in the Key Value [cmdbkeyvalue] table, linking tags to the respective cloud resources for enhanced resource categorization and filtering.
Practical Considerations for ServiceNow Customers
- Verify AWS discovery prerequisites as outlined in the AWS discovery patterns documentation to ensure a smooth discovery process.
- Manage the Resource Inclusion List carefully to avoid duplicate entries during discovery of FSx File Systems.
- Enable the FSx pattern explicitly to begin discovery; this does not count as a customization and remains compatible with future updates.
- Review discovered data in both CMDB and non-CMDB tables to gain complete insight into FSx File Systems, their configurations, lifecycle status, and associated metadata such as tags.
- Leverage the CI relationships and references to understand dependencies and hosting details, aiding in impact analysis and operational management.
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 AWS 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 AWS Resource Inventory discovery with Patterns.
- 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. |