Skip to content

Models

nautobot_device_lifecycle_mgmt.models

Django models for the Lifecycle Management plugin.

CVELCM

Bases: PrimaryModel

CVELCM is a model representation of a cve vulnerability record.

Source code in nautobot_device_lifecycle_mgmt/models.py 
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
@extras_features(
    "custom_fields",
    "custom_links",
    "custom_validators",
    "export_templates",
    "graphql",
    "relationships",
    "webhooks",
    "statuses",
)
class CVELCM(PrimaryModel):
    """CVELCM is a model representation of a cve vulnerability record."""

    name = models.CharField(max_length=16, blank=False, unique=True)
    published_date = models.DateField(verbose_name="Published Date")
    link = models.URLField()
    status = StatusField(
        null=True,
        blank=True,
        on_delete=models.PROTECT,
        to="extras.status",
    )
    description = models.CharField(max_length=255, blank=True, null=True)
    severity = models.CharField(
        max_length=50, choices=choices.CVESeverityChoices, default=choices.CVESeverityChoices.NONE
    )
    cvss = models.FloatField(blank=True, null=True, verbose_name="CVSS Base Score")
    cvss_v2 = models.FloatField(blank=True, null=True, verbose_name="CVSSv2 Score")
    cvss_v3 = models.FloatField(blank=True, null=True, verbose_name="CVSSv3 Score")
    fix = models.CharField(max_length=255, blank=True, null=True)
    comments = models.TextField(blank=True)

    csv_headers = [
        "name",
        "published_date",
        "link",
        "status",
        "description",
        "severity",
        "cvss",
        "cvss_v2",
        "cvss_v3",
        "fix",
        "comments",
    ]

    class Meta:
        """Meta attributes for the class."""

        verbose_name = "CVE"

        ordering = ("severity", "name")

    def get_absolute_url(self):
        """Returns the Detail view for CVELCM models."""
        return reverse("plugins:nautobot_device_lifecycle_mgmt:cvelcm", kwargs={"pk": self.pk})

    def __str__(self):
        """String representation of the model."""
        return f"{self.name}"

    def to_csv(self):
        """Return fields for bulk view."""
        return (
            self.name,
            self.published_date,
            self.link,
            self.status,
            self.description,
            self.severity,
            self.cvss,
            self.cvss_v2,
            self.cvss_v3,
            self.fix,
            self.comments,
        )

Meta

Meta attributes for the class.

Source code in nautobot_device_lifecycle_mgmt/models.py 
781
782
783
784
785
786
class Meta:
    """Meta attributes for the class."""

    verbose_name = "CVE"

    ordering = ("severity", "name")

__str__()

String representation of the model.

Source code in nautobot_device_lifecycle_mgmt/models.py 
792
793
794
def __str__(self):
    """String representation of the model."""
    return f"{self.name}"

get_absolute_url()

Returns the Detail view for CVELCM models.

Source code in nautobot_device_lifecycle_mgmt/models.py 
788
789
790
def get_absolute_url(self):
    """Returns the Detail view for CVELCM models."""
    return reverse("plugins:nautobot_device_lifecycle_mgmt:cvelcm", kwargs={"pk": self.pk})

to_csv()

Return fields for bulk view.

Source code in nautobot_device_lifecycle_mgmt/models.py 
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
def to_csv(self):
    """Return fields for bulk view."""
    return (
        self.name,
        self.published_date,
        self.link,
        self.status,
        self.description,
        self.severity,
        self.cvss,
        self.cvss_v2,
        self.cvss_v3,
        self.fix,
        self.comments,
    )

ContactLCM

Bases: PrimaryModel

ContactLCM is a model representation of a contact used in Contracts.

Source code in nautobot_device_lifecycle_mgmt/models.py 
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
@extras_features(
    "custom_fields",
    "custom_links",
    "custom_validators",
    "export_templates",
    "graphql",
    "relationships",
    "webhooks",
)
class ContactLCM(PrimaryModel):
    """ContactLCM is a model representation of a contact used in Contracts."""

    name = models.CharField(max_length=80, null=True)
    address = models.CharField(max_length=200, blank=True)
    phone = models.CharField(max_length=20, blank=True)
    email = models.EmailField(blank=True, verbose_name="Contact E-mail")
    comments = models.TextField(blank=True)
    priority = models.PositiveIntegerField(default=100)
    type = models.CharField(max_length=50, default=choices.PoCTypeChoices.UNASSIGNED)
    contract = models.ForeignKey(
        to="nautobot_device_lifecycle_mgmt.ContractLCM", on_delete=models.CASCADE, verbose_name="Contract", null=True
    )

    csv_headers = [
        "contract",
        "name",
        "address",
        "phone",
        "email",
        "comments",
        "type",
        "priority",
    ]

    class Meta:
        """Meta attributes for the class."""

        verbose_name = "Contract POC"

        unique_together = ("contract", "name")

        ordering = ("contract", "priority", "name")

    def get_absolute_url(self):
        """Returns the Detail view for ContactLCM models."""
        return reverse("plugins:nautobot_device_lifecycle_mgmt:contactlcm", kwargs={"pk": self.pk})

    def clean(self):
        """Override clean to do custom validation."""
        super().clean()
        if not any([self.phone, self.email]):
            raise ValidationError("Must specify at least one of phone or email for contact.")

        # Would to an exist() here, but we need to compare the pk in the event we are editing an
        # existing record.
        primary = ContactLCM.objects.filter(contract=self.contract, type=choices.PoCTypeChoices.PRIMARY).first()
        if primary:
            if self.pk != primary.pk and self.type == choices.PoCTypeChoices.PRIMARY:
                raise ValidationError(f"A primary contact already exist for contract {self.contract.name}.")

    def __str__(self):
        """String representation of the model."""
        return f"{self.name}"

    def to_csv(self):
        """Return fields for bulk view."""
        return (
            self.contract,
            self.name,
            self.address,
            self.phone,
            self.email,
            self.comments,
            self.type,
            self.priority,
        )

Meta

Meta attributes for the class.

Source code in nautobot_device_lifecycle_mgmt/models.py 
691
692
693
694
695
696
697
698
class Meta:
    """Meta attributes for the class."""

    verbose_name = "Contract POC"

    unique_together = ("contract", "name")

    ordering = ("contract", "priority", "name")

__str__()

String representation of the model.

Source code in nautobot_device_lifecycle_mgmt/models.py 
717
718
719
def __str__(self):
    """String representation of the model."""
    return f"{self.name}"

clean()

Override clean to do custom validation.

Source code in nautobot_device_lifecycle_mgmt/models.py 
704
705
706
707
708
709
710
711
712
713
714
715
def clean(self):
    """Override clean to do custom validation."""
    super().clean()
    if not any([self.phone, self.email]):
        raise ValidationError("Must specify at least one of phone or email for contact.")

    # Would to an exist() here, but we need to compare the pk in the event we are editing an
    # existing record.
    primary = ContactLCM.objects.filter(contract=self.contract, type=choices.PoCTypeChoices.PRIMARY).first()
    if primary:
        if self.pk != primary.pk and self.type == choices.PoCTypeChoices.PRIMARY:
            raise ValidationError(f"A primary contact already exist for contract {self.contract.name}.")

get_absolute_url()

Returns the Detail view for ContactLCM models.

Source code in nautobot_device_lifecycle_mgmt/models.py 
700
701
702
def get_absolute_url(self):
    """Returns the Detail view for ContactLCM models."""
    return reverse("plugins:nautobot_device_lifecycle_mgmt:contactlcm", kwargs={"pk": self.pk})

to_csv()

Return fields for bulk view.

Source code in nautobot_device_lifecycle_mgmt/models.py 
721
722
723
724
725
726
727
728
729
730
731
732
def to_csv(self):
    """Return fields for bulk view."""
    return (
        self.contract,
        self.name,
        self.address,
        self.phone,
        self.email,
        self.comments,
        self.type,
        self.priority,
    )

ContractLCM

Bases: PrimaryModel

ContractLCM model for plugin.

Source code in nautobot_device_lifecycle_mgmt/models.py 
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
@extras_features(
    "custom_fields",
    "custom_links",
    "custom_validators",
    "export_templates",
    "graphql",
    "relationships",
    "webhooks",
)
class ContractLCM(PrimaryModel):
    """ContractLCM model for plugin."""

    # Set model columns
    provider = models.ForeignKey(
        to="nautobot_device_lifecycle_mgmt.ProviderLCM",
        on_delete=models.CASCADE,
        verbose_name="Vendor",
        blank=True,
        null=True,
    )
    name = models.CharField(max_length=100, unique=True)
    number = models.CharField(max_length=100, null=True, blank=True)
    start = models.DateField(null=True, blank=True, verbose_name="Contract Start Date")
    end = models.DateField(null=True, blank=True, verbose_name="Contract End Date")
    cost = models.DecimalField(null=True, blank=True, decimal_places=2, max_digits=15, verbose_name="Contract Cost")
    support_level = models.CharField(verbose_name="Support Level", max_length=64, blank=True, null=True)
    currency = models.CharField(verbose_name="Currency", max_length=4, blank=True, null=True)
    contract_type = models.CharField(null=True, blank=True, max_length=32, verbose_name="Contract Type")
    comments = models.TextField(blank=True)

    csv_headers = [
        "provider",
        "name",
        "number",
        "start",
        "end",
        "cost",
        "currency",
        "support_level",
        "contract_type",
        "comments",
    ]

    class Meta:
        """Meta attributes for the ContractLCM class."""

        verbose_name = "Contract"
        ordering = ("name", "start")

    def __str__(self):
        """String representation of ContractLCM."""
        return self.name

    def get_absolute_url(self):
        """Returns the Detail view for ContractLCM models."""
        return reverse("plugins:nautobot_device_lifecycle_mgmt:contractlcm", kwargs={"pk": self.pk})

    @property
    def expired(self):
        """Return True or False if chosen field is expired."""
        if not self.end:
            return False
        return datetime.today().date() >= self.end

    def save(self, *args, **kwargs):
        """Override save to assert a full clean."""
        # Full clean to assert custom validation in clean() for ORM, etc.
        super().full_clean()
        super().save(*args, **kwargs)

    def clean(self):
        """Override clean to do custom validation."""
        super().clean()

        if self.end and self.start:
            if self.end <= self.start:
                raise ValidationError("End date must be after the start date of the contract.")

    def to_csv(self):
        """Return fields for bulk view."""
        return (
            self.provider,
            self.name,
            self.number,
            self.start,
            self.end,
            self.cost,
            self.currency,
            self.support_level,
            self.contract_type,
            self.comments,
        )

expired property

Return True or False if chosen field is expired.

Meta

Meta attributes for the ContractLCM class.

Source code in nautobot_device_lifecycle_mgmt/models.py 
539
540
541
542
543
class Meta:
    """Meta attributes for the ContractLCM class."""

    verbose_name = "Contract"
    ordering = ("name", "start")

__str__()

String representation of ContractLCM.

Source code in nautobot_device_lifecycle_mgmt/models.py 
545
546
547
def __str__(self):
    """String representation of ContractLCM."""
    return self.name

clean()

Override clean to do custom validation.

Source code in nautobot_device_lifecycle_mgmt/models.py 
566
567
568
569
570
571
572
def clean(self):
    """Override clean to do custom validation."""
    super().clean()

    if self.end and self.start:
        if self.end <= self.start:
            raise ValidationError("End date must be after the start date of the contract.")

get_absolute_url()

Returns the Detail view for ContractLCM models.

Source code in nautobot_device_lifecycle_mgmt/models.py 
549
550
551
def get_absolute_url(self):
    """Returns the Detail view for ContractLCM models."""
    return reverse("plugins:nautobot_device_lifecycle_mgmt:contractlcm", kwargs={"pk": self.pk})

save(args, kwargs)

Override save to assert a full clean.

Source code in nautobot_device_lifecycle_mgmt/models.py 
560
561
562
563
564
def save(self, *args, **kwargs):
    """Override save to assert a full clean."""
    # Full clean to assert custom validation in clean() for ORM, etc.
    super().full_clean()
    super().save(*args, **kwargs)

to_csv()

Return fields for bulk view.

Source code in nautobot_device_lifecycle_mgmt/models.py 
574
575
576
577
578
579
580
581
582
583
584
585
586
587
def to_csv(self):
    """Return fields for bulk view."""
    return (
        self.provider,
        self.name,
        self.number,
        self.start,
        self.end,
        self.cost,
        self.currency,
        self.support_level,
        self.contract_type,
        self.comments,
    )

DeviceSoftwareValidationResult

Bases: PrimaryModel

Device Software validation details model.

Source code in nautobot_device_lifecycle_mgmt/models.py 
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
@extras_features(
    "graphql",
)
class DeviceSoftwareValidationResult(PrimaryModel):
    """Device Software validation details model."""

    device = models.OneToOneField(
        to="dcim.Device",
        on_delete=models.CASCADE,
        help_text="The device",
        blank=False,
        related_name="device_software_validation",
    )
    software = models.ForeignKey(
        to="SoftwareLCM", on_delete=models.CASCADE, help_text="Device software", null=True, blank=True, related_name="+"
    )
    is_validated = models.BooleanField(null=True, blank=True)
    last_run = models.DateTimeField(null=True, blank=True)
    run_type = models.CharField(max_length=50, choices=choices.ReportRunTypeChoices)

    class Meta:
        """Meta attributes for DeviceSoftwareValidationResult."""

        verbose_name = "Device Software Validation Report"
        ordering = ("device",)

    def to_csv(self):
        """Indicates model fields to return as csv."""
        return (self.device.name, self.software.version, self.is_validated, self.last_run, self.run_type)

Meta

Meta attributes for DeviceSoftwareValidationResult.

Source code in nautobot_device_lifecycle_mgmt/models.py 
455
456
457
458
459
class Meta:
    """Meta attributes for DeviceSoftwareValidationResult."""

    verbose_name = "Device Software Validation Report"
    ordering = ("device",)

to_csv()

Indicates model fields to return as csv.

Source code in nautobot_device_lifecycle_mgmt/models.py 
461
462
463
def to_csv(self):
    """Indicates model fields to return as csv."""
    return (self.device.name, self.software.version, self.is_validated, self.last_run, self.run_type)

HardwareLCM

Bases: PrimaryModel

HardwareLCM model for plugin.

Source code in nautobot_device_lifecycle_mgmt/models.py 
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
@extras_features(
    "custom_fields",
    "custom_links",
    "custom_validators",
    "export_templates",
    "graphql",
    "relationships",
    "webhooks",
)
class HardwareLCM(PrimaryModel):
    """HardwareLCM model for plugin."""

    # Set model columns
    device_type = models.ForeignKey(
        to="dcim.DeviceType",
        on_delete=models.CASCADE,
        verbose_name="Device Type",
        blank=True,
        null=True,
    )
    inventory_item = models.CharField(verbose_name="Inventory Item Part", max_length=255, blank=True, null=True)
    release_date = models.DateField(null=True, blank=True, verbose_name="Release Date")
    end_of_sale = models.DateField(null=True, blank=True, verbose_name="End of Sale")
    end_of_support = models.DateField(null=True, blank=True, verbose_name="End of Support")
    end_of_sw_releases = models.DateField(null=True, blank=True, verbose_name="End of Software Releases")
    end_of_security_patches = models.DateField(null=True, blank=True, verbose_name="End of Security Patches")
    documentation_url = models.URLField(blank=True, verbose_name="Documentation URL")
    comments = models.TextField(null=True, blank=True, verbose_name="Comments")

    csv_headers = [
        "device_type",
        "inventory_item",
        "release_date",
        "end_of_sale",
        "end_of_support",
        "end_of_sw_releases",
        "end_of_security_patches",
        "documentation_url",
        "comments",
    ]

    class Meta:
        """Meta attributes for the HardwareLCM class."""

        verbose_name = "Hardware Notice"
        ordering = ("end_of_support", "end_of_sale")
        constraints = [
            models.UniqueConstraint(fields=["device_type"], name="unique_device_type"),
            models.UniqueConstraint(fields=["inventory_item"], name="unique_inventory_item_part"),
            models.CheckConstraint(
                check=(
                    models.Q(inventory_item__isnull=True, device_type__isnull=False)
                    | models.Q(inventory_item__isnull=False, device_type__isnull=True)
                ),
                name="At least one of InventoryItem or DeviceType specified.",
            ),
            models.CheckConstraint(
                check=(models.Q(end_of_sale__isnull=False) | models.Q(end_of_support__isnull=False)),
                name="End of Sale or End of Support must be specified.",
            ),
        ]

    def __str__(self):
        """String representation of HardwareLCMs."""
        name = f"Device Type: {self.device_type}" if self.device_type else f"Inventory Part: {self.inventory_item}"
        if self.end_of_support:
            msg = f"{name} - End of support: {self.end_of_support}"
        else:
            msg = f"{name} - End of sale: {self.end_of_sale}"
        return msg

    def get_absolute_url(self):
        """Returns the Detail view for HardwareLCM models."""
        return reverse("plugins:nautobot_device_lifecycle_mgmt:hardwarelcm", kwargs={"pk": self.pk})

    @property
    def expired(self):
        """Return True or False if chosen field is expired."""
        expired_field = settings.PLUGINS_CONFIG["nautobot_device_lifecycle_mgmt"].get("expired_field", "end_of_support")

        # If the chosen or default field does not exist, default to one of the required fields that are present
        if not getattr(self, expired_field) and not getattr(self, "end_of_support"):
            expired_field = "end_of_sale"
        elif not getattr(self, expired_field) and not getattr(self, "end_of_sale"):
            expired_field = "end_of_support"

        today = datetime.today().date()
        return today >= getattr(self, expired_field)

    def save(self, *args, **kwargs):
        """Override save to assert a full clean."""
        # Full clean to assert custom validation in clean() for ORM, etc.
        super().full_clean()
        super().save(*args, **kwargs)

    def clean(self):
        """Override clean to do custom validation."""
        super().clean()

        if not any([self.inventory_item, self.device_type]) or all([self.inventory_item, self.device_type]):
            raise ValidationError(
                {
                    "inventory_item": "One and only one of `Inventory Item` OR `Device Type` must be specified.",
                    "device_type": "One and only one of `Inventory Item` OR `Device Type` must be specified.",
                }
            )

        if not self.end_of_sale and not self.end_of_support:
            raise ValidationError(
                {
                    "end_of_sale": "End of Sale or End of Support must be specified.",
                    "end_of_support": "End of Sale or End of Support must be specified.",
                }
            )

    def to_csv(self):
        """Return fields for bulk view."""
        return (
            self.device_type,
            self.inventory_item,
            self.release_date,
            self.end_of_sale,
            self.end_of_support,
            self.end_of_sw_releases,
            self.end_of_security_patches,
            self.documentation_url,
            self.comments,
        )

expired property

Return True or False if chosen field is expired.

Meta

Meta attributes for the HardwareLCM class.

Source code in nautobot_device_lifecycle_mgmt/models.py 
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
class Meta:
    """Meta attributes for the HardwareLCM class."""

    verbose_name = "Hardware Notice"
    ordering = ("end_of_support", "end_of_sale")
    constraints = [
        models.UniqueConstraint(fields=["device_type"], name="unique_device_type"),
        models.UniqueConstraint(fields=["inventory_item"], name="unique_inventory_item_part"),
        models.CheckConstraint(
            check=(
                models.Q(inventory_item__isnull=True, device_type__isnull=False)
                | models.Q(inventory_item__isnull=False, device_type__isnull=True)
            ),
            name="At least one of InventoryItem or DeviceType specified.",
        ),
        models.CheckConstraint(
            check=(models.Q(end_of_sale__isnull=False) | models.Q(end_of_support__isnull=False)),
            name="End of Sale or End of Support must be specified.",
        ),
    ]

__str__()

String representation of HardwareLCMs.

Source code in nautobot_device_lifecycle_mgmt/models.py 
88
89
90
91
92
93
94
95
def __str__(self):
    """String representation of HardwareLCMs."""
    name = f"Device Type: {self.device_type}" if self.device_type else f"Inventory Part: {self.inventory_item}"
    if self.end_of_support:
        msg = f"{name} - End of support: {self.end_of_support}"
    else:
        msg = f"{name} - End of sale: {self.end_of_sale}"
    return msg

clean()

Override clean to do custom validation.

Source code in nautobot_device_lifecycle_mgmt/models.py 
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
def clean(self):
    """Override clean to do custom validation."""
    super().clean()

    if not any([self.inventory_item, self.device_type]) or all([self.inventory_item, self.device_type]):
        raise ValidationError(
            {
                "inventory_item": "One and only one of `Inventory Item` OR `Device Type` must be specified.",
                "device_type": "One and only one of `Inventory Item` OR `Device Type` must be specified.",
            }
        )

    if not self.end_of_sale and not self.end_of_support:
        raise ValidationError(
            {
                "end_of_sale": "End of Sale or End of Support must be specified.",
                "end_of_support": "End of Sale or End of Support must be specified.",
            }
        )

get_absolute_url()

Returns the Detail view for HardwareLCM models.

Source code in nautobot_device_lifecycle_mgmt/models.py 
97
98
99
def get_absolute_url(self):
    """Returns the Detail view for HardwareLCM models."""
    return reverse("plugins:nautobot_device_lifecycle_mgmt:hardwarelcm", kwargs={"pk": self.pk})

save(args, kwargs)

Override save to assert a full clean.

Source code in nautobot_device_lifecycle_mgmt/models.py 
115
116
117
118
119
def save(self, *args, **kwargs):
    """Override save to assert a full clean."""
    # Full clean to assert custom validation in clean() for ORM, etc.
    super().full_clean()
    super().save(*args, **kwargs)

to_csv()

Return fields for bulk view.

Source code in nautobot_device_lifecycle_mgmt/models.py 
141
142
143
144
145
146
147
148
149
150
151
152
153
def to_csv(self):
    """Return fields for bulk view."""
    return (
        self.device_type,
        self.inventory_item,
        self.release_date,
        self.end_of_sale,
        self.end_of_support,
        self.end_of_sw_releases,
        self.end_of_security_patches,
        self.documentation_url,
        self.comments,
    )

InventoryItemSoftwareValidationResult

Bases: PrimaryModel

InventoryItem Software validation details model.

Source code in nautobot_device_lifecycle_mgmt/models.py 
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
@extras_features(
    "graphql",
)
class InventoryItemSoftwareValidationResult(PrimaryModel):
    """InventoryItem Software validation details model."""

    inventory_item = models.OneToOneField(
        to="dcim.InventoryItem",
        on_delete=models.CASCADE,
        help_text="The Inventory Item",
        related_name="inventoryitem_software_validation",
    )
    software = models.ForeignKey(
        to="SoftwareLCM", on_delete=models.CASCADE, help_text="Inventory Item software", blank=True, null=True
    )
    is_validated = models.BooleanField(null=True, blank=True)
    last_run = models.DateTimeField(null=True, blank=True)
    run_type = models.CharField(max_length=50, choices=choices.ReportRunTypeChoices)

    class Meta:
        """Meta attributes for InventoryItemSoftwareValidationResult."""

        verbose_name = "Inventory Item Software Validation Report"
        ordering = ("inventory_item",)

    def to_csv(self):
        """Indicates model fields to return as csv."""
        return (self.inventory_item.name, self.software.version, self.is_validated, self.last_run, self.run_type)

Meta

Meta attributes for InventoryItemSoftwareValidationResult.

Source code in nautobot_device_lifecycle_mgmt/models.py 
485
486
487
488
489
class Meta:
    """Meta attributes for InventoryItemSoftwareValidationResult."""

    verbose_name = "Inventory Item Software Validation Report"
    ordering = ("inventory_item",)

to_csv()

Indicates model fields to return as csv.

Source code in nautobot_device_lifecycle_mgmt/models.py 
491
492
493
def to_csv(self):
    """Indicates model fields to return as csv."""
    return (self.inventory_item.name, self.software.version, self.is_validated, self.last_run, self.run_type)

ProviderLCM

Bases: OrganizationalModel

ProviderLCM model for plugin.

Source code in nautobot_device_lifecycle_mgmt/models.py 
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
@extras_features(
    "custom_fields",
    "custom_links",
    "custom_validators",
    "export_templates",
    "graphql",
    "relationships",
    "webhooks",
)
class ProviderLCM(OrganizationalModel):
    """ProviderLCM model for plugin."""

    # Set model columns
    name = models.CharField(max_length=100, unique=True)
    description = models.CharField(max_length=200, blank=True)
    physical_address = models.CharField(max_length=200, blank=True)
    country = models.CharField(max_length=3, blank=True)
    phone = models.CharField(max_length=20, blank=True)
    email = models.EmailField(blank=True, verbose_name="E-mail")
    portal_url = models.URLField(blank=True, verbose_name="Portal URL")
    comments = models.TextField(blank=True)

    csv_headers = [
        "name",
        "description",
        "physical_address",
        "country",
        "phone",
        "email",
        "portal_url",
        "comments",
    ]

    class Meta:
        """Meta attributes for the class."""

        verbose_name = "Vendor"
        ordering = ("name",)

    def __str__(self):
        """String representation of ProviderLCM."""
        return self.name

    def get_absolute_url(self):
        """Returns the Detail view for ProviderLCM models."""
        return reverse("plugins:nautobot_device_lifecycle_mgmt:providerlcm", kwargs={"pk": self.pk})

    def save(self, *args, **kwargs):
        """Override save to assert a full clean."""
        # Full clean to assert custom validation in clean() for ORM, etc.
        super().full_clean()
        super().save(*args, **kwargs)

    def to_csv(self):
        """Return fields for bulk view."""
        return (
            self.name,
            self.description,
            self.physical_address,
            self.country,
            self.phone,
            self.email,
            self.portal_url,
            self.comments,
        )

Meta

Meta attributes for the class.

Source code in nautobot_device_lifecycle_mgmt/models.py 
623
624
625
626
627
class Meta:
    """Meta attributes for the class."""

    verbose_name = "Vendor"
    ordering = ("name",)

__str__()

String representation of ProviderLCM.

Source code in nautobot_device_lifecycle_mgmt/models.py 
629
630
631
def __str__(self):
    """String representation of ProviderLCM."""
    return self.name

get_absolute_url()

Returns the Detail view for ProviderLCM models.

Source code in nautobot_device_lifecycle_mgmt/models.py 
633
634
635
def get_absolute_url(self):
    """Returns the Detail view for ProviderLCM models."""
    return reverse("plugins:nautobot_device_lifecycle_mgmt:providerlcm", kwargs={"pk": self.pk})

save(args, kwargs)

Override save to assert a full clean.

Source code in nautobot_device_lifecycle_mgmt/models.py 
637
638
639
640
641
def save(self, *args, **kwargs):
    """Override save to assert a full clean."""
    # Full clean to assert custom validation in clean() for ORM, etc.
    super().full_clean()
    super().save(*args, **kwargs)

to_csv()

Return fields for bulk view.

Source code in nautobot_device_lifecycle_mgmt/models.py 
643
644
645
646
647
648
649
650
651
652
653
654
def to_csv(self):
    """Return fields for bulk view."""
    return (
        self.name,
        self.description,
        self.physical_address,
        self.country,
        self.phone,
        self.email,
        self.portal_url,
        self.comments,
    )

SoftwareImageLCM

Bases: PrimaryModel

SoftwareImageLCM model.

Source code in nautobot_device_lifecycle_mgmt/models.py 
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
@extras_features(
    "custom_fields",
    "custom_links",
    "custom_validators",
    "export_templates",
    "graphql",
    "relationships",
    "statuses",
    "webhooks",
)
class SoftwareImageLCM(PrimaryModel):
    """SoftwareImageLCM model."""

    image_file_name = models.CharField(blank=False, max_length=100, verbose_name="Image File Name")
    software = models.ForeignKey(
        to="SoftwareLCM", on_delete=models.CASCADE, related_name="software_images", verbose_name="Software Version"
    )
    device_types = models.ManyToManyField(to="dcim.DeviceType", related_name="+", blank=True)
    inventory_items = models.ManyToManyField(to="dcim.InventoryItem", related_name="+", blank=True)
    object_tags = models.ManyToManyField(to="extras.Tag", related_name="+", blank=True)
    download_url = models.URLField(blank=True, verbose_name="Download URL")
    image_file_checksum = models.CharField(blank=True, max_length=256, verbose_name="Image File Checksum")
    default_image = models.BooleanField(verbose_name="Default Image", default=False)

    csv_headers = [
        "image_file_name",
        "software",
        "device_types",
        "inventory_items",
        "object_tags",
        "download_url",
        "image_file_checksum",
        "default_image",
    ]

    class Meta:
        """Meta attributes for SoftwareImageLCM."""

        verbose_name = "Software Image"
        ordering = ("software", "default_image", "image_file_name")
        unique_together = ("image_file_name", "software")

    def __str__(self):
        """String representation of SoftwareImageLCM."""
        msg = f"{self.image_file_name}"
        return msg

    def get_absolute_url(self):
        """Returns the Detail view for SoftwareImageLCM models."""
        return reverse("plugins:nautobot_device_lifecycle_mgmt:softwareimagelcm", kwargs={"pk": self.pk})

    def to_csv(self):
        """Return fields for bulk view."""
        return (
            self.image_file_name,
            self.software.id,
            ",".join(str(device_type["model"]) for device_type in self.device_types.values()),
            ",".join(str(inventory_item["id"]) for inventory_item in self.inventory_items.values()),
            ",".join(str(object_tag["slug"]) for object_tag in self.object_tags.values()),
            self.download_url,
            self.image_file_checksum,
            self.default_image,
        )

    objects = SoftwareImageLCMQuerySet.as_manager()

Meta

Meta attributes for SoftwareImageLCM.

Source code in nautobot_device_lifecycle_mgmt/models.py 
292
293
294
295
296
297
class Meta:
    """Meta attributes for SoftwareImageLCM."""

    verbose_name = "Software Image"
    ordering = ("software", "default_image", "image_file_name")
    unique_together = ("image_file_name", "software")

__str__()

String representation of SoftwareImageLCM.

Source code in nautobot_device_lifecycle_mgmt/models.py 
299
300
301
302
def __str__(self):
    """String representation of SoftwareImageLCM."""
    msg = f"{self.image_file_name}"
    return msg

get_absolute_url()

Returns the Detail view for SoftwareImageLCM models.

Source code in nautobot_device_lifecycle_mgmt/models.py 
304
305
306
def get_absolute_url(self):
    """Returns the Detail view for SoftwareImageLCM models."""
    return reverse("plugins:nautobot_device_lifecycle_mgmt:softwareimagelcm", kwargs={"pk": self.pk})

to_csv()

Return fields for bulk view.

Source code in nautobot_device_lifecycle_mgmt/models.py 
308
309
310
311
312
313
314
315
316
317
318
319
def to_csv(self):
    """Return fields for bulk view."""
    return (
        self.image_file_name,
        self.software.id,
        ",".join(str(device_type["model"]) for device_type in self.device_types.values()),
        ",".join(str(inventory_item["id"]) for inventory_item in self.inventory_items.values()),
        ",".join(str(object_tag["slug"]) for object_tag in self.object_tags.values()),
        self.download_url,
        self.image_file_checksum,
        self.default_image,
    )

SoftwareImageLCMQuerySet

Bases: RestrictedQuerySet

Queryset for SoftwareImageLCM objects.

Source code in nautobot_device_lifecycle_mgmt/models.py 
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
class SoftwareImageLCMQuerySet(RestrictedQuerySet):
    """Queryset for `SoftwareImageLCM` objects."""

    def get_for_object(self, obj):
        """Return all `SoftwareImageLCM` assigned to the given object."""
        if not isinstance(obj, models.Model):
            raise TypeError(f"{obj} is not an instance of Django Model class")
        if isinstance(obj, Device):
            qs = DeviceSoftwareImageFilter(qs=self, item_obj=obj).filter_qs()
        elif isinstance(obj, InventoryItem):
            qs = InventoryItemSoftwareImageFilter(qs=self, item_obj=obj).filter_qs()
        else:
            qs = self

        return qs

get_for_object(obj)

Return all SoftwareImageLCM assigned to the given object.

Source code in nautobot_device_lifecycle_mgmt/models.py 
243
244
245
246
247
248
249
250
251
252
253
254
def get_for_object(self, obj):
    """Return all `SoftwareImageLCM` assigned to the given object."""
    if not isinstance(obj, models.Model):
        raise TypeError(f"{obj} is not an instance of Django Model class")
    if isinstance(obj, Device):
        qs = DeviceSoftwareImageFilter(qs=self, item_obj=obj).filter_qs()
    elif isinstance(obj, InventoryItem):
        qs = InventoryItemSoftwareImageFilter(qs=self, item_obj=obj).filter_qs()
    else:
        qs = self

    return qs

SoftwareLCM

Bases: PrimaryModel

Software Life-Cycle Management model.

Source code in nautobot_device_lifecycle_mgmt/models.py 
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
@extras_features(
    "custom_fields",
    "custom_links",
    "custom_validators",
    "export_templates",
    "graphql",
    "relationships",
    "statuses",
    "webhooks",
)
class SoftwareLCM(PrimaryModel):
    """Software Life-Cycle Management model."""

    device_platform = models.ForeignKey(to="dcim.Platform", on_delete=models.CASCADE, verbose_name="Device Platform")
    version = models.CharField(max_length=50)
    alias = models.CharField(max_length=50, blank=True, null=True)
    release_date = models.DateField(null=True, blank=True, verbose_name="Release Date")
    end_of_support = models.DateField(null=True, blank=True, verbose_name="End of Software Support")
    documentation_url = models.URLField(blank=True, verbose_name="Documentation URL")
    long_term_support = models.BooleanField(verbose_name="Long Term Support", default=False)
    pre_release = models.BooleanField(verbose_name="Pre-Release", default=False)

    csv_headers = [
        "device_platform",
        "version",
        "alias",
        "release_date",
        "end_of_support",
        "documentation_url",
        "long_term_support",
        "pre_release",
    ]

    class Meta:
        """Meta attributes for SoftwareLCM."""

        verbose_name = "Software"
        ordering = ("device_platform", "version", "end_of_support", "release_date")
        unique_together = (
            "device_platform",
            "version",
        )

    def __str__(self):
        """String representation of SoftwareLCM."""
        return f"{self.device_platform} - {self.version}"

    def get_absolute_url(self):
        """Returns the Detail view for SoftwareLCM models."""
        return reverse("plugins:nautobot_device_lifecycle_mgmt:softwarelcm", kwargs={"pk": self.pk})

    def to_csv(self):
        """Return fields for bulk view."""
        return (
            self.device_platform.slug,
            self.version,
            self.alias,
            self.release_date,
            self.end_of_support,
            self.documentation_url,
            self.long_term_support,
            self.pre_release,
        )

    objects = SoftwareLCMQuerySet.as_manager()

Meta

Meta attributes for SoftwareLCM.

Source code in nautobot_device_lifecycle_mgmt/models.py 
206
207
208
209
210
211
212
213
214
class Meta:
    """Meta attributes for SoftwareLCM."""

    verbose_name = "Software"
    ordering = ("device_platform", "version", "end_of_support", "release_date")
    unique_together = (
        "device_platform",
        "version",
    )

__str__()

String representation of SoftwareLCM.

Source code in nautobot_device_lifecycle_mgmt/models.py 
216
217
218
def __str__(self):
    """String representation of SoftwareLCM."""
    return f"{self.device_platform} - {self.version}"

get_absolute_url()

Returns the Detail view for SoftwareLCM models.

Source code in nautobot_device_lifecycle_mgmt/models.py 
220
221
222
def get_absolute_url(self):
    """Returns the Detail view for SoftwareLCM models."""
    return reverse("plugins:nautobot_device_lifecycle_mgmt:softwarelcm", kwargs={"pk": self.pk})

to_csv()

Return fields for bulk view.

Source code in nautobot_device_lifecycle_mgmt/models.py 
224
225
226
227
228
229
230
231
232
233
234
235
def to_csv(self):
    """Return fields for bulk view."""
    return (
        self.device_platform.slug,
        self.version,
        self.alias,
        self.release_date,
        self.end_of_support,
        self.documentation_url,
        self.long_term_support,
        self.pre_release,
    )

SoftwareLCMQuerySet

Bases: RestrictedQuerySet

Queryset for SoftwareLCM objects.

Source code in nautobot_device_lifecycle_mgmt/models.py 
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
class SoftwareLCMQuerySet(RestrictedQuerySet):
    """Queryset for `SoftwareLCM` objects."""

    def get_for_object(self, obj):
        """Return all `SoftwareLCM` assigned to the given object."""
        if not isinstance(obj, models.Model):
            raise TypeError(f"{obj} is not an instance of Django Model class")
        if isinstance(obj, Device):
            qs = DeviceSoftwareFilter(qs=self, item_obj=obj).filter_qs()
        elif isinstance(obj, InventoryItem):
            qs = InventoryItemSoftwareFilter(qs=self, item_obj=obj).filter_qs()
        else:
            qs = self

        return qs

get_for_object(obj)

Return all SoftwareLCM assigned to the given object.

Source code in nautobot_device_lifecycle_mgmt/models.py 
159
160
161
162
163
164
165
166
167
168
169
170
def get_for_object(self, obj):
    """Return all `SoftwareLCM` assigned to the given object."""
    if not isinstance(obj, models.Model):
        raise TypeError(f"{obj} is not an instance of Django Model class")
    if isinstance(obj, Device):
        qs = DeviceSoftwareFilter(qs=self, item_obj=obj).filter_qs()
    elif isinstance(obj, InventoryItem):
        qs = InventoryItemSoftwareFilter(qs=self, item_obj=obj).filter_qs()
    else:
        qs = self

    return qs

ValidatedSoftwareLCM

Bases: PrimaryModel

ValidatedSoftwareLCM model.

Source code in nautobot_device_lifecycle_mgmt/models.py 
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
@extras_features(
    "custom_fields",
    "custom_links",
    "custom_validators",
    "export_templates",
    "relationships",
    "statuses",
    "webhooks",
)
class ValidatedSoftwareLCM(PrimaryModel):
    """ValidatedSoftwareLCM model."""

    software = models.ForeignKey(to="SoftwareLCM", on_delete=models.CASCADE, verbose_name="Software Version")
    devices = models.ManyToManyField(to="dcim.Device", related_name="+", blank=True)
    device_types = models.ManyToManyField(to="dcim.DeviceType", related_name="+", blank=True)
    device_roles = models.ManyToManyField(to="dcim.DeviceRole", related_name="+", blank=True)
    inventory_items = models.ManyToManyField(to="dcim.InventoryItem", related_name="+", blank=True)
    object_tags = models.ManyToManyField(to="extras.Tag", related_name="+", blank=True)
    start = models.DateField(verbose_name="Valid Since")
    end = models.DateField(verbose_name="Valid Until", blank=True, null=True)
    preferred = models.BooleanField(verbose_name="Preferred Version", default=False)

    csv_headers = [
        "software",
        "devices",
        "device_types",
        "device_roles",
        "inventory_items",
        "object_tags",
        "start",
        "end",
        "preferred",
    ]

    class Meta:
        """Meta attributes for ValidatedSoftwareLCM."""

        verbose_name = "Validated Software"
        ordering = ("software", "preferred", "start")

    def __str__(self):
        """String representation of ValidatedSoftwareLCM."""
        msg = f"{self.software} - Valid since: {self.start}"
        return msg

    def get_absolute_url(self):
        """Returns the Detail view for ValidatedSoftwareLCM models."""
        return reverse("plugins:nautobot_device_lifecycle_mgmt:validatedsoftwarelcm", kwargs={"pk": self.pk})

    @property
    def valid(self):
        """Return True if software is currently valid, else return False."""
        today = date.today()
        if self.end:
            return self.end >= today >= self.start

        return today >= self.start

    def save(self, *args, **kwargs):
        """Override save to assert a full clean."""
        # Full clean to assert custom validation in clean() for ORM, etc.
        super().full_clean()
        super().save(*args, **kwargs)

    def clean(self):
        """Override clean to do custom validation."""
        super().clean()

        if (
            ValidatedSoftwareLCM.objects.filter(software=self.software, start=self.start, end=self.end)
            .exclude(pk=self.pk)
            .exists()
        ):
            raise ValidationError(
                "Validated Software object with this Software and Valid Since and Valid Until dates already exists."
            )

    def to_csv(self):
        """Return fields for bulk view."""
        return (
            self.software.id,
            ",".join(str(device["name"]) for device in self.devices.values()),
            ",".join(str(device_type["model"]) for device_type in self.device_types.values()),
            ",".join(str(device_role["slug"]) for device_role in self.device_roles.values()),
            ",".join(str(inventory_item["id"]) for inventory_item in self.inventory_items.values()),
            ",".join(str(object_tag["slug"]) for object_tag in self.object_tags.values()),
            self.start,
            self.end,
            self.preferred,
        )

    objects = ValidatedSoftwareLCMQuerySet.as_manager()

valid property

Return True if software is currently valid, else return False.

Meta

Meta attributes for ValidatedSoftwareLCM.

Source code in nautobot_device_lifecycle_mgmt/models.py 
375
376
377
378
379
class Meta:
    """Meta attributes for ValidatedSoftwareLCM."""

    verbose_name = "Validated Software"
    ordering = ("software", "preferred", "start")

__str__()

String representation of ValidatedSoftwareLCM.

Source code in nautobot_device_lifecycle_mgmt/models.py 
381
382
383
384
def __str__(self):
    """String representation of ValidatedSoftwareLCM."""
    msg = f"{self.software} - Valid since: {self.start}"
    return msg

clean()

Override clean to do custom validation.

Source code in nautobot_device_lifecycle_mgmt/models.py 
405
406
407
408
409
410
411
412
413
414
415
416
def clean(self):
    """Override clean to do custom validation."""
    super().clean()

    if (
        ValidatedSoftwareLCM.objects.filter(software=self.software, start=self.start, end=self.end)
        .exclude(pk=self.pk)
        .exists()
    ):
        raise ValidationError(
            "Validated Software object with this Software and Valid Since and Valid Until dates already exists."
        )

get_absolute_url()

Returns the Detail view for ValidatedSoftwareLCM models.

Source code in nautobot_device_lifecycle_mgmt/models.py 
386
387
388
def get_absolute_url(self):
    """Returns the Detail view for ValidatedSoftwareLCM models."""
    return reverse("plugins:nautobot_device_lifecycle_mgmt:validatedsoftwarelcm", kwargs={"pk": self.pk})

save(args, kwargs)

Override save to assert a full clean.

Source code in nautobot_device_lifecycle_mgmt/models.py 
399
400
401
402
403
def save(self, *args, **kwargs):
    """Override save to assert a full clean."""
    # Full clean to assert custom validation in clean() for ORM, etc.
    super().full_clean()
    super().save(*args, **kwargs)

to_csv()

Return fields for bulk view.

Source code in nautobot_device_lifecycle_mgmt/models.py 
418
419
420
421
422
423
424
425
426
427
428
429
430
def to_csv(self):
    """Return fields for bulk view."""
    return (
        self.software.id,
        ",".join(str(device["name"]) for device in self.devices.values()),
        ",".join(str(device_type["model"]) for device_type in self.device_types.values()),
        ",".join(str(device_role["slug"]) for device_role in self.device_roles.values()),
        ",".join(str(inventory_item["id"]) for inventory_item in self.inventory_items.values()),
        ",".join(str(object_tag["slug"]) for object_tag in self.object_tags.values()),
        self.start,
        self.end,
        self.preferred,
    )

ValidatedSoftwareLCMQuerySet

Bases: RestrictedQuerySet

Queryset for ValidatedSoftwareLCM objects.

Source code in nautobot_device_lifecycle_mgmt/models.py 
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
class ValidatedSoftwareLCMQuerySet(RestrictedQuerySet):
    """Queryset for `ValidatedSoftwareLCM` objects."""

    def get_for_object(self, obj):
        """Return all `ValidatedSoftwareLCM` assigned to the given object."""
        if not isinstance(obj, models.Model):
            raise TypeError(f"{obj} is not an instance of Django Model class")
        if isinstance(obj, Device):
            qs = DeviceValidatedSoftwareFilter(qs=self, item_obj=obj).filter_qs()
        elif isinstance(obj, InventoryItem):
            qs = InventoryItemValidatedSoftwareFilter(qs=self, item_obj=obj).filter_qs()
        else:
            qs = self

        return qs

get_for_object(obj)

Return all ValidatedSoftwareLCM assigned to the given object.

Source code in nautobot_device_lifecycle_mgmt/models.py 
327
328
329
330
331
332
333
334
335
336
337
338
def get_for_object(self, obj):
    """Return all `ValidatedSoftwareLCM` assigned to the given object."""
    if not isinstance(obj, models.Model):
        raise TypeError(f"{obj} is not an instance of Django Model class")
    if isinstance(obj, Device):
        qs = DeviceValidatedSoftwareFilter(qs=self, item_obj=obj).filter_qs()
    elif isinstance(obj, InventoryItem):
        qs = InventoryItemValidatedSoftwareFilter(qs=self, item_obj=obj).filter_qs()
    else:
        qs = self

    return qs

VulnerabilityLCM

Bases: PrimaryModel

VulnerabilityLCM is a model representation of vulnerability that affects a device.

Source code in nautobot_device_lifecycle_mgmt/models.py 
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
@extras_features(
    "custom_fields",
    "custom_links",
    "custom_validators",
    "export_templates",
    "graphql",
    "relationships",
    "webhooks",
    "statuses",
)
class VulnerabilityLCM(PrimaryModel):
    """VulnerabilityLCM is a model representation of vulnerability that affects a device."""

    cve = models.ForeignKey(CVELCM, on_delete=models.CASCADE, blank=True, null=True)
    software = models.ForeignKey(SoftwareLCM, on_delete=models.CASCADE, blank=True, null=True)
    device = models.ForeignKey(Device, on_delete=models.CASCADE, blank=True, null=True)
    inventory_item = models.ForeignKey(InventoryItem, on_delete=models.CASCADE, blank=True, null=True)
    status = StatusField(
        null=True,
        blank=True,
        on_delete=models.PROTECT,
        to="extras.status",
    )

    csv_headers = [
        "cve",
        "software",
        "device",
        "inventory_item",
        "status",
    ]

    class Meta:
        """Meta attributes for the class."""

        verbose_name = "Vulnerability"
        verbose_name_plural = "Vulnerabilities"

    def get_absolute_url(self):
        """Returns the Detail view for VulnerabilityLCM models."""
        return reverse("plugins:nautobot_device_lifecycle_mgmt:vulnerabilitylcm", kwargs={"pk": self.pk})

    def __str__(self):
        """String representation of the model."""
        name = f"Device: {self.device}" if self.device else f"Inventory Part: {self.inventory_item}"
        if self.software:
            name += f" - Software: {self.software}"
        if self.cve:
            name += f" - CVE: {self.cve}"
        return name

    def to_csv(self):
        """Return fields for bulk view."""
        return (
            self.cve,
            self.software,
            self.device,
            self.inventory_item,
            self.status,
        )

Meta

Meta attributes for the class.

Source code in nautobot_device_lifecycle_mgmt/models.py 
845
846
847
848
849
class Meta:
    """Meta attributes for the class."""

    verbose_name = "Vulnerability"
    verbose_name_plural = "Vulnerabilities"

__str__()

String representation of the model.

Source code in nautobot_device_lifecycle_mgmt/models.py 
855
856
857
858
859
860
861
862
def __str__(self):
    """String representation of the model."""
    name = f"Device: {self.device}" if self.device else f"Inventory Part: {self.inventory_item}"
    if self.software:
        name += f" - Software: {self.software}"
    if self.cve:
        name += f" - CVE: {self.cve}"
    return name

get_absolute_url()

Returns the Detail view for VulnerabilityLCM models.

Source code in nautobot_device_lifecycle_mgmt/models.py 
851
852
853
def get_absolute_url(self):
    """Returns the Detail view for VulnerabilityLCM models."""
    return reverse("plugins:nautobot_device_lifecycle_mgmt:vulnerabilitylcm", kwargs={"pk": self.pk})

to_csv()

Return fields for bulk view.

Source code in nautobot_device_lifecycle_mgmt/models.py 
864
865
866
867
868
869
870
871
872
def to_csv(self):
    """Return fields for bulk view."""
    return (
        self.cve,
        self.software,
        self.device,
        self.inventory_item,
        self.status,
    )