models.py 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123
  1. from django.core.urlresolvers import reverse
  2. from django.db import models
  3. from dcim.models import Site, Interface
  4. from utilities.models import CreatedUpdatedModel
  5. class Provider(CreatedUpdatedModel):
  6. """
  7. Each Circuit belongs to a Provider. This is usually a telecommunications company or similar organization. This model
  8. stores information pertinent to the user's relationship with the Provider.
  9. """
  10. name = models.CharField(max_length=50, unique=True)
  11. slug = models.SlugField(unique=True)
  12. asn = models.PositiveIntegerField(blank=True, null=True, verbose_name='ASN')
  13. account = models.CharField(max_length=30, blank=True, verbose_name='Account number')
  14. portal_url = models.URLField(blank=True, verbose_name='Portal')
  15. noc_contact = models.TextField(blank=True, verbose_name='NOC contact')
  16. admin_contact = models.TextField(blank=True, verbose_name='Admin contact')
  17. comments = models.TextField(blank=True)
  18. class Meta:
  19. ordering = ['name']
  20. def __unicode__(self):
  21. return self.name
  22. def get_absolute_url(self):
  23. return reverse('circuits:provider', args=[self.slug])
  24. def to_csv(self):
  25. return ','.join([
  26. self.name,
  27. self.slug,
  28. str(self.asn) if self.asn else '',
  29. self.account,
  30. self.portal_url,
  31. ])
  32. class CircuitType(models.Model):
  33. """
  34. Circuits can be orgnanized by their functional role. For example, a user might wish to define CircuitTypes named
  35. "Long Haul," "Metro," or "Out-of-Band".
  36. """
  37. name = models.CharField(max_length=50, unique=True)
  38. slug = models.SlugField(unique=True)
  39. class Meta:
  40. ordering = ['name']
  41. def __unicode__(self):
  42. return self.name
  43. def get_absolute_url(self):
  44. return "{}?type={}".format(reverse('circuits:circuit_list'), self.slug)
  45. class Circuit(CreatedUpdatedModel):
  46. """
  47. A communications circuit connects two points. Each Circuit belongs to a Provider; Providers may have multiple
  48. circuits. Each circuit is also assigned a CircuitType and a Site. A Circuit may be terminated to a specific device
  49. interface, but this is not required. Circuit port speed and commit rate are measured in Kbps.
  50. """
  51. cid = models.CharField(max_length=50, verbose_name='Circuit ID')
  52. provider = models.ForeignKey('Provider', related_name='circuits', on_delete=models.PROTECT)
  53. type = models.ForeignKey('CircuitType', related_name='circuits', on_delete=models.PROTECT)
  54. site = models.ForeignKey(Site, related_name='circuits', on_delete=models.PROTECT)
  55. interface = models.OneToOneField(Interface, related_name='circuit', blank=True, null=True)
  56. install_date = models.DateField(blank=True, null=True, verbose_name='Date installed')
  57. port_speed = models.PositiveIntegerField(verbose_name='Port speed (Kbps)')
  58. commit_rate = models.PositiveIntegerField(blank=True, null=True, verbose_name='Commit rate (Kbps)')
  59. xconnect_id = models.CharField(max_length=50, blank=True, verbose_name='Cross-connect ID')
  60. pp_info = models.CharField(max_length=100, blank=True, verbose_name='Patch panel/port(s)')
  61. comments = models.TextField(blank=True)
  62. class Meta:
  63. ordering = ['provider', 'cid']
  64. unique_together = ['provider', 'cid']
  65. def __unicode__(self):
  66. return "{0} {1}".format(self.provider, self.cid)
  67. def get_absolute_url(self):
  68. return reverse('circuits:circuit', args=[self.pk])
  69. def to_csv(self):
  70. return ','.join([
  71. self.cid,
  72. self.provider.name,
  73. self.type.name,
  74. self.site.name,
  75. self.install_date.isoformat() if self.install_date else '',
  76. str(self.port_speed),
  77. str(self.commit_rate) if self.commit_rate else '',
  78. self.xconnect_id,
  79. self.pp_info,
  80. ])
  81. def _humanize_speed(self, speed):
  82. """
  83. Humanize speeds given in Kbps (e.g. 10000000 becomes '10 Gbps')
  84. """
  85. if speed >= 1000000000 and speed % 1000000000 == 0:
  86. return '{} Tbps'.format(speed / 1000000000)
  87. elif speed >= 1000000 and speed % 1000000 == 0:
  88. return '{} Gbps'.format(speed / 1000000)
  89. elif speed >= 1000 and speed % 1000 == 0:
  90. return '{} Mbps'.format(speed / 1000)
  91. elif speed >= 1000:
  92. return '{} Mbps'.format(float(speed) / 1000)
  93. else:
  94. return '{} Kbps'.format(speed)
  95. @property
  96. def port_speed_human(self):
  97. return self._humanize_speed(self.port_speed)
  98. @property
  99. def commit_rate_human(self):
  100. if not self.commit_rate:
  101. return ''
  102. return self._humanize_speed(self.commit_rate)