TIM SDN Adapter
TIM SDN Adapter supports collection of Inventory and Topology
data, statistics and notifications from TIM SDN Controller. TIM SDN Controller
is an IP based TIM’s home-grown controller. This adapter supports inventory and
topology discovery. Router Inventory Item and Port Inventory Item are
discovered in inventory. Ports (Rphysical/RAggregate/RLogical) and
Links(Physical/Aggregate/Logical) are discovered in topology.
TIM SDN Controller
supports statistics and notifications over Kafka streams. Kafka clients may
subscribe to specific topics. The authentication methodology uses SASL with SSL
using SCRAM_SHA_512 as the authentication scheme.
The following table lists the tested devices, and their versions supported on the Cisco EPNM adapter.
Table 1. Versions Supported by the Cisco EPNM Adapter
TIM SDN |
Tested Devices |
|
Cisco ASR 903, Cisco ASR 9000 |
Table 2. Network Discovery Details for the TIM SDN Adapter
IP |
Topology IP |
Services IP |
PMs IP |
Devices, Physical Ports |
Router Physical, RouteAggregate, Router Logical. |
None |
OCTET IN OCTET OUT PACKET IN PACKET OUT. |
Table 3. P Inventory Item Attributes and Accessibility Details for the Cisco EPNM Adapter
Attribute |
Card |
Fan |
IGP |
Port |
Power Supply |
Router |
Comments |
access_identifier |
No |
No |
No |
Yes |
No |
No |
|
card_status |
No |
No |
No |
No |
No |
No |
|
card_type |
No |
No |
No |
No |
No |
No |
|
children |
No |
No |
No |
No |
No |
Yes |
|
children_ports |
No |
No |
No |
No |
No |
No |
|
desc |
No |
No |
No |
Yes |
No |
Yes |
|
device |
No |
No |
No |
Yes |
No |
No |
|
device_family |
No |
No |
No |
No |
No |
Yes |
|
device_type |
No |
No |
No |
No |
No |
Yes |
|
domain_name |
No |
No |
No |
No |
No |
No |
|
equip_state |
No |
No |
No |
Yes |
No |
No |
|
extra |
No |
No |
No |
Yes |
No |
No |
Links, Port Type |
form_factor |
No |
No |
No |
No |
No |
No |
|
guid |
No |
No |
No |
Yes |
No |
Yes |
|
igp_type |
No |
No |
No |
No |
No |
No |
|
isis_info |
No |
No |
No |
No |
No |
No |
|
management_ip |
No |
No |
No |
No |
No |
Yes |
|
model_number |
No |
No |
No |
No |
No |
Yes |
|
name |
No |
No |
No |
Yes |
No |
Yes |
|
oui |
No |
No |
No |
No |
No |
No |
|
parent |
Yes |
No |
No |
Yes |
No |
No |
|
part_number |
No |
No |
No |
No |
No |
Yes |
|
pluggability |
No |
No |
No |
No |
No |
No |
|
ports |
No |
No |
No |
No |
No |
No |
|
provider |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
reachability_status |
No |
No |
Yes |
No |
No |
Yes |
|
router_id |
No |
No |
Yes |
No |
No |
No |
|
serial_number |
Yes |
Yes |
No |
Yes |
Yes |
Yes |
|
site |
No |
No |
No |
No |
No |
Yes |
|
software_version |
No |
No |
No |
No |
No |
Yes |
|
sr_capabilities |
No |
No |
Yes |
No |
No |
No |
|
srlgs |
Yes |
No |
No |
No |
No |
No |
|
supported_lambdas |
No |
No |
No |
No |
No |
No |
|
supported_physical_layers |
No |
No |
No |
No |
No |
No |
|
supported_reacability_meters |
No |
No |
No |
No |
No |
No |
|
supported_speeds |
No |
No |
No |
No |
No |
No |
|
tags |
No |
No |
No |
No |
No |
Yes |
|
topology_id |
No |
No |
No |
No |
No |
No |
|
tunable_type |
No |
No |
No |
No |
No |
No |
|
tuned_lambda |
No |
No |
No |
No |
No |
No |
|
type |
|
|
|
|
|
No |
|
vendor |
No |
No |
No |
No |
No |
Yes |
|
Table 4. IP Port Item Attributes and Accessibility Details for the TIM SDN Adapter
Attribute |
IGP |
RAggregate |
RLogical |
RPhysical |
Uni |
VirtualUni |
Comments |
adjacency |
No |
No |
No |
Yes |
No |
No |
|
admin_groups |
No |
No |
No |
No |
No |
No |
|
admin_status |
No |
Yes |
Yes |
Yes |
No |
No |
|
child_role |
No |
No |
No |
No |
No |
No |
|
containing_service |
No |
No |
No |
No |
No |
No |
|
Desc |
No |
Yes |
Yes |
Yes |
No |
No |
|
Device |
No |
No |
Yes |
Yes |
No |
No |
|
egress_bandwidth_profile |
No |
No |
No |
No |
No |
No |
|
eline_specific |
No |
No |
No |
No |
No |
No |
|
eth_port_type |
No |
No |
No |
Yes |
No |
No |
|
Extra |
No |
Yes |
Yes |
Yes |
No |
No |
Device Name, Interface Id |
Guid |
No |
Yes |
Yes |
Yes |
No |
No |
|
has_service_end_point_capability |
No |
No |
No |
No |
No |
No |
|
if_index |
No |
Yes |
Yes |
No |
No |
No |
|
igp_instance_name |
No |
No |
No |
No |
No |
No |
|
igp_metric |
Yes |
No |
No |
No |
No |
No |
|
ingress_bandwidth_profile |
No |
No |
No |
No |
No |
No |
|
ip_address |
Yes |
No |
No |
No |
No |
No |
|
is_all_to_one_bundling |
No |
No |
No |
No |
No |
No |
|
is_loopback |
No |
No |
Yes |
No |
No |
No |
|
is_management |
No |
No |
No |
No |
No |
No |
|
is_router_id |
No |
No |
Yes |
No |
No |
No |
|
is_stats_dummy |
No |
No |
No |
No |
No |
No |
|
isis_info |
Yes |
No |
No |
No |
No |
No |
|
l_2_vpn_specific |
No |
No |
No |
No |
No |
No |
|
l_3_vpn_specific |
No |
No |
No |
No |
No |
No |
|
Links |
No |
No |
No |
No |
No |
No |
|
lower_ports |
No |
Yes |
Yes |
No |
No |
No |
|
mapped_ce_tags |
No |
No |
No |
No |
No |
No |
|
max_link_bandwidth |
No |
No |
No |
No |
No |
No |
|
max_reservable_link_bandwidth |
No |
No |
No |
No |
No |
No |
|
mtu_size |
No |
No |
No |
No |
No |
No |
|
name |
No |
Yes |
Yes |
Yes |
No |
No |
|
non_primary_ips |
No |
No |
No |
No |
No |
No |
|
oper_status |
No |
Yes |
Yes |
Yes |
No |
No |
|
ospf_info |
No |
No |
No |
No |
No |
No |
|
parent |
No |
Yes |
Yes |
Yes |
No |
No |
|
physical_address |
No |
Yes |
No |
Yes |
No |
No |
|
primary_ip |
No |
No |
Yes |
No |
No |
No |
|
provider |
No |
Yes |
Yes |
Yes |
No |
No |
|
rsvp_reserved_bandwidth_bps |
No |
No |
No |
No |
No |
No |
|
rsvp_static_bandwidth_bps |
No |
No |
No |
No |
No |
No |
|
speed_bps |
No |
No |
No |
Yes |
No |
No |
|
sr_prefix_sids |
Yes |
No |
No |
No |
No |
No |
|
srlgs |
No |
No |
No |
No |
No |
No |
|
Tags |
No |
No |
No |
No |
No |
No |
|
te_metric |
No |
No |
No |
No |
No |
No |
|
unnumbered_interface_id |
No |
No |
No |
No |
No |
No |
|
unreserved_link_bw_for_priority_index |
No |
No |
No |
No |
No |
No |
|
upper_ports |
No |
Yes |
No |
Yes |
No |
No |
|
vlan |
No |
No |
Yes |
No |
No |
No |
|
Table 5. IP Link Item Attributes and Accessibility Details for the Cisco EPNM Adapter
Attribute |
E-Line |
IGP |
PseudoWire |
RAggregate |
RLogical |
RPhysical |
Comments |
active_protection_priority |
No |
No |
No |
No |
No |
No |
|
desc |
No |
No |
No |
No |
No |
No |
|
distance_meters |
No |
No |
No |
No |
No |
No |
|
evc_performance_profile |
No |
No |
No |
No |
No |
No |
|
evpn_instance |
No |
No |
No |
No |
No |
No |
|
extra |
No |
No |
No |
Yes |
Yes |
Yes |
|
guid |
No |
No |
No |
Yes |
Yes |
Yes |
|
is_bidi |
No |
No |
No |
Yes |
Yes |
Yes |
|
is_ce_vlan_cos_preservation |
No |
No |
No |
No |
No |
No |
|
latency_micros |
No |
No |
No |
No |
No |
No |
|
mapping_status |
No |
No |
No |
No |
No |
No |
|
name |
No |
No |
No |
Yes |
Yes |
Yes |
|
oper_status |
No |
No |
No |
Yes |
Yes |
Yes |
|
path_group_type |
No |
No |
No |
No |
No |
No |
|
paths |
Yes |
No |
No |
No |
No |
|
|
port_a |
No |
No |
No |
Yes |
Yes |
Yes |
|
port_b |
No |
No |
No |
Yes |
Yes |
Yes |
|
protection_status |
No |
No |
No |
No |
No |
No |
|
provider |
No |
No |
No |
Yes |
Yes |
Yes |
|
role |
No |
No |
No |
No |
No |
No |
|
rx_label |
No |
No |
No |
No |
No |
No |
|
sr_adjacency_sids |
No |
No |
No |
No |
No |
No |
|
srlgs |
No |
No |
No |
No |
No |
No |
|
tags |
No |
No |
No |
No |
No |
No |
|
tx_label |
No |
No |
No |
No |
No |
No |
|
used_by_hops |
No |
No |
No |
No |
No |
No |
|
vc_id |
No |
No |
Yes |
No |
No |
No |
|
Table 6. Service Item Attributes and Accessibility Details for the TIM SDN Adapter
Service Item |
E-Line Services |
admin_status |
No |
contained_ports |
No |
customer_details |
No |
customer_name |
No |
deployment_state |
No |
desc |
No |
extra |
No |
guid |
No |
is_protection_degraded |
No |
name |
No |
oper_status |
No |
parent |
No |
provider |
No |
service_health |
No |
service_intent |
No |
service_intent_relation |
No |
tags |
No |
Table 7. IP Statistics Data Collected by the TIM SDN Adapter
Type |
Is Collected |
In Traffic bps |
Yes |
Out Traffic bps |
Yes |
In Packets/sec |
Yes |
Out Packets/sec |
Yes |
Table 8. Configuration Parameters for the TIM SDN Adapter
Name |
Description |
Default |
Range |
Enabled |
Enable/disable the adapter. |
False |
Enable this option once you are ready to run the adapter. |
Logging Level |
The logging level at which the discovery cycle is reported in the adapter log. |
INFO |
DEBUG, INFO, WARNING, ERROR, CRITICAL |
Adapter Properties |
|
|
|
Polling Cycle [sec] |
Poll every X seconds. |
3600 |
[30] |
Connection Properties |
|
|
|
Host |
(http|https)://<server_Ip>[:<port>] |
|
|
Credentials |
Credentials of type HTTP are defined in the “Credentials” tab of Device Manager. |
|
|
Timeout [sec] |
The connection timeout. |
60 |
|
Collection
Properties |
Used to customize
the collection of parameters that the adapter will use in a specific
installation. |
|
|
Enable Inventory |
Whether the
inventory collection is enabled or
disabled. |
False |
|
Enable Topology |
Whether the topology collection is enabled or disabled. |
False |
|
Notification Config |
|
|
|
Enabled |
Whether Notification collection is enabled to disabled |
False |
|
log_notificaitions |
Whether to log the received notifications |
True |
|
log_level |
The logging level at which the notifications |
Debug |
|
congestion_control_period_sec |
Congestion control period (in sec) |
5 |
|
max_notification_wait_perios_sec |
Maximum Notification Wait Period (in sec) |
60 |
|
Notification Kafka Topics |
Kafka topic where the notifications are published by the controller |
|
|
Stats Collector |
|
|
|
Enable Stats |
Whether or not statistics
collection is enabled. |
False |
|
stats_kafka_topic |
Kafka topic where the aggregated stats are published |
|
|
Kafka Configuration |
|
|
|
List of
bootstrap servers |
List of server ips
separated by comma |
|
|
Kafka Port |
Kafka Port for Notifications and Stats support |
9094 |
0 to 65535 |
SASL SSL
Credentials |
Credentials of
type SSH-KEY are defined in the “Credentials” tab of Device Manager. |
|
|
Enable Kafka
Log |
Enables Kafka logs related to Kafka exchanges |
False |
|
Kafka log
level |
Kafka log level |
Info |
|
max_kafka_silent_time_sec |
Max Kafka silent period to declare connection loss |
600 |
|
kafka_timer_sleep_time_sec |
Kafka timer frequency to monitor silent period |
60 |
|
Use Kafka
Broker Settings for Name Resolutio |
Enable this setting if Kafka uses hostname and DNS
resolution does not use DNS server |
False |
|
List of Kafka
Brokers |
List of hostnames to ip
mapping to be defined as csv in the below format “host_name_1:ipv4_address_1,host_name_2:ipv4_address_2” |
|
|
· IP based controller supporting Inventory and Topology discovery only
· Inventory discovery discovers devices and Port Inventory Item only.
· Topology discovery support includes Ports and Links support only