AWS CloudHSM HSM pattern-based discovery
Summarize
Summary of AWS CloudHSM HSM pattern-based discovery
This documentation covers how the Discovery and Service Mapping Patterns application in ServiceNow discovers AWS CloudHSM HSM resources within your cloud environment. The pattern-based discovery identifies and maps AWS CloudHSM HSM devices and populates related data into both CMDB and non-CMDB tables for comprehensive asset and configuration management.
Show less
Key Features
- Pattern Activation: The AWS CloudHSM HSM discovery pattern is disabled by default. Activating or deactivating it is no longer considered a customization, allowing automatic updates while preserving activation status across upgrades.
- Discovery Prerequisites: Requires meeting AWS discovery prerequisites and ensuring the resource is not listed in the Resource Inclusion List table to avoid duplicate discovery.
- GovCloud Support: Discovery supports AWS GovCloud (US) accounts by configuring the AWS service account with the appropriate datacenter URL.
- Data Population: The pattern populates data into:
- Non-CMDB tables, such as
cmdbawscloudhsmhsm, capturing details like HSM name, availability zone, status, cluster ID, HSM type, and ARN. - CMDB tables, such as
cmdbcicmpresource, with resource type, install status, operational status, and ARN. - CI Relationships: Creates relationships linking CloudHSM HSM resources to Cloud Resources and AWS Datacenters, supporting holistic configuration item (CI) mapping.
Practical Guidance for ServiceNow Customers
- Ensure you have the latest Discovery and Service Mapping Patterns application and meet AWS discovery prerequisites before enabling the AWS CloudHSM HSM pattern.
- Check and remove any relevant AWS CloudHSM resources from the Resource Inclusion List to prevent duplicates.
- Activate the AWS CloudHSM HSM discovery pattern to start discovering and mapping these resources.
- Configure discovery schedules to include GovCloud accounts if applicable, by setting the correct datacenter URL in AWS service accounts.
- Review discovered HSM data in both CMDB and non-CMDB tables to gain visibility into your CloudHSM inventory and status.
By following these steps, you can maintain an accurate, up-to-date inventory of AWS CloudHSM HSM devices within your ServiceNow CMDB, enabling improved asset management, operational insight, and integration with other ITSM processes.
Discovery and Service Mapping Patterns finds AWS services 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.
- 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 - CloudHSM HSM - 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 unique identifier of the HSM within the cluster. |
| Availability Zone [availability_zone] | The AWS availability zone where the HSM is deployed. |
| Status [status] | The current operational status of the HSM. |
| Cluster Id [cluster_id] | The unique identifier of the HSM cluster. |
| Configuration Item [configuration_item] | References the Cloud Resource [cmdb_ci_cmp_resource] table. |
| Hsm Type [hsm_type] | The type or model specification of the HSM device. |
| Object Id [object_id] | The Amazon Resource Name (ARN) uniquely identifying the AWS CloudHSM HSM. The ARN consists of the discovered region, account ID, and HSM ID in the following format: arn:aws:cloudhsm:<region>:<account_id>:hsm/<hsm_id>. |
Data stored in CMDB tables
Discovery and Service Mapping Patterns application populates data in the CMDB when running the Amazon AWS - CloudHSM HSM - Extended Inventory (LP) pattern.
| Field | Description |
|---|---|
| Name [name] | The unique identifier of the HSM within the cluster. |
| Resource type [resource_type] | Type of resource. The value is set to AWS::CloudHSM::HSM. |
| Install Status [install_status] | Install status of the resource. Default value is Installed. |
| Object ID [object_id] | The ARN uniquely identifying the AWS CloudHSM HSM. The ARN consists of the discovered region, account ID, and HSM ID in the following format: arn:aws:cloudhsm:<region>:<account_id>:hsm/<hsm_id>. |
| Operational status [operational_status] | Operational status of the resource. Default value is Operational. |
CI relationships
The Amazon AWS - CloudHSM HSM - Extended Inventory (LP) pattern creates these relationships to support AWS CloudHSM HSM discovery.
| CI | Relationship | CI |
|---|---|---|
| Cloud Resource [cmdb_ci_cmp_resource] | Hosted on::Hosts | AWS Datacenter [cmdb_ci_aws_datacenter] |
| AWS CloudHSM HSM [cmdb_aws_cloudhsm_hsm] | References | Cloud Resource [cmdb_ci_cmp_resource] |