IPAM Discovery integration
Summarize
Summary of IPAM Discovery integration
The IP Address Management (IPAM) to Discovery integration automates the creation and management of Discovery schedules based on IPv6 network data stored in IPAM. This integration ensures your Discovery schedules stay synchronized with changes in your IPv6 network infrastructure, providing an accurate and current network environment view.
Show less
How it works
- Identifies resources marked as operational within IPAM tables
- Processes only the latest IPAM changes since the last sync
- Creates Discovery schedules organized by a specified tag key
- Disables Discovery schedules that no longer have valid network targets
Benefits
- Automated schedule management: Removes the need for manual creation and upkeep of Discovery schedules for IPv4 and IPv6 networks.
- Synchronization with network changes: Automatically updates Discovery schedules to reflect changes in networks, subnets, or IP addresses.
- Incremental updates: Improves performance by processing only changed resources since the last synchronization.
- IPv4 and IPv6 support: Supports both protocols with configurable capacity limits and mapping methods.
- Audit capability: Maintains execution records for tracking synchronization history and changes.
Requirements
- Service Graph Connector Central (SGC Central) v2.4.0 with sgcadmin access
- Service Graph Connector for Infoblox v1.5.0 with sgcadmin access
- CMDB Workspace v9.0.0
- Discovery Admin Workspace v1.13.0 with discoveryadmin access
- ServiceNow AI Platform Australia, ZP8 or later, or YP13 or later
- IPAM data with operational status in Managed Network, IP Network Subnet, and Allocated IP Address tables
- Valid CIDR notation for IPv4 subnets and established relationships among networks, subnets, and IP addresses
Configuration
System properties control integration behavior, including:
- Debug logging: Enable detailed logs for troubleshooting
- Grouping schedules: Define a tag key (e.g., "location") to group auto-generated schedules
- IPv4 and IPv6 address limits: Set maximum IP counts per Discovery schedule (default 65,536 for IPv4, 20,000 for IPv6; lower limits for older releases)
Generated Discovery schedules
- Maintenance source set to “Discovery-IPAM Integration”
- Schedules initially created in an inactive state for review
- MID Server selection configured to MID Cluster
- Descriptions include managed network, grouping criteria, and navigation links
Execution tracking and monitoring
- Each synchronization creates an execution record capturing performance metrics, configuration, and errors
- Prevents simultaneous executions to avoid conflicts
- Review execution records regularly to monitor integration health and troubleshoot issues
Optimization best practices
- Assign subnets to groups within your IPAM product to enable organized scheduling
- Regularly review and adjust generated Discovery schedules as network environments evolve
- Enable debug logging during initial setup to understand integration behavior
- Ensure IPAM data quality before running synchronizations to avoid errors
- Monitor execution records frequently to detect and resolve any issues promptly
The IP Address Management (IPAM) to Discovery integration feature enables your organization to automatically create and manage Discovery schedules based on your IPv6 network infrastructure data stored in IPAM. This integration keeps your discovery processes synchronized with your IPv6 network changes, providing a complete and up-to-date view of your network environment.
How it works
- Identifying resources marked as operational in your IPAM tables
- Processing only the latest changes from your IPAM system
- Creating Discovery schedules, organized by a tag key you specify
- Disabling schedules that no longer have valid network targets
Benefits
- Automated schedule management: Eliminates the need to manually create and maintain Discovery schedules for IPv4 and IPv6 networks.
- Synchronization with network changes: Automatically adjusts Discovery schedules when networks, subnets, or IP addresses change.
- Incremental updates: Processes only resources that changed since the last synchronization, improving performance.
- IPv4 and IPv6 support: Handles both IPv4 and IPv6 networks with separate capacity limits and mapping approaches.
- Audit capability: Maintains history of synchronization activities and changes through execution records.
Requirements
- Service Graph Connector Central (SGC Central) v2.4.0 with sgc_admin access.
- Service Graph Connector for Infoblox v1.5.0 with sgc_admin access.
- CMDB Workspace v9.0.0.
- Discovery Admin Workspace v1.13.0 with discovery_admin access.
- Australia, ZP8 or later, or YP13 or later version of the ServiceNow AI Platform.
- Managed networks in the Managed Network [cmdb_ci_managed_network] table with operational status set to operational.
- IP subnets in the IP Network Subnet [cmdb_ci_ip_network_subnet] table with operational status set to operational.
- IP addresses in the Allocated IP Address [cmdb_ci_allocated_ip_address] table with operational status set to operational.
- IPv4 subnets should have valid Classless Inter-Domain Routing (CIDR) notation for address calculation.
- Relationships between managed networks, subnets, and IP addresses must be established.
Configuration
The following system properties control the behavior of the integration:
| Property name | Description | Default |
|---|---|---|
| glide.discovery.schedule.autogenerate.debug | Enables detailed logging for troubleshooting. | false |
| glide.discovery.schedule.autogenerate.group | Groups auto-generated IPAM Discovery schedules by a specific tag or attribute. The value of this property represents a key that IPAM retrieves and stores in the Key Values [cmdb_key_value] table. For example, entering "location" as the value would group the schedules by their associated locations. | empty |
| glide.discovery.schedule_ipv4_limit | Defines the maximum number of IPv4 addresses that can be included in a single auto‑generated IPv4 Discovery schedule. | 65,536 |
| glide.discovery.schedule_ipv6_limit | Defines the maximum number of IPv6 addresses that can be included in a single auto‑generated IPv6 Discovery schedule. | 20,000 Note: On instances below ZP3 and YP9, the maximum number of IPv6 addresses per schedule must not exceed 5,000, which is also the default value in Yokohama and earlier releases. |
Generated schedules
- Maintenance source: The maintenance source is set to Discovery-IPAM Integration.
- Initial state: The initial state is set to inactive for review before activation.
- MID Server selection: The MID Server selection is set to MID Cluster.
- Description: Includes managed network, grouping criteria, and navigation links.
Execution tracking
Each synchronization creates an execution record that captures performance metrics, configuration settings, and any errors. The integration helps prevent multiple simultaneous executions to avoid conflicts. Review these execution records to monitor integration health.
Optimization
Follow these guidelines to get the most out of the IPAM Discovery integration:
- Assign subnets to groups: In your IPAM product, assign subnets to groups so the integration can organize schedules based on those groupings.
- Regular maintenance: Periodically review generated schedules and adjust configuration as needed.
- Test with debug logging: Enable debug logging during initial implementation to understand behavior.
- Verify data quality: Verify IPAM data quality before running synchronization.
- Monitor execution records: Review execution records regularly to catch issues early.