Models

nautobot_device_lifecycle_mgmt.models

Django models for the Lifecycle Management app.

CVELCM

Bases: PrimaryModel

CVELCM is a model representation of a cve vulnerability record.

Source code in nautobot_device_lifecycle_mgmt/models.py

@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=CHARFIELD_MAX_LENGTH, blank=False, unique=True)
    published_date = models.DateField(verbose_name="Published Date")
    last_modified_date = models.DateField(null=True, blank=True, verbose_name="Last Modified Date")
    link = models.URLField()
    status = StatusField(
        null=True,
        blank=True,
        on_delete=models.PROTECT,
        to="extras.status",
    )
    description = models.TextField(blank=True, default="")
    severity = models.CharField(
        max_length=CHARFIELD_MAX_LENGTH, 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, default="")
    comments = models.TextField(blank=True, default="")
    affected_softwares = models.ManyToManyField(
        to="dcim.SoftwareVersion", related_name="corresponding_cves", blank=True
    )
    old_affected_softwares = models.ManyToManyField(to="SoftwareLCM", related_name="corresponding_cves", blank=True)

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

        verbose_name = "CVE"

        ordering = ("severity", "name")

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

Meta

Meta attributes for the class.

Source code in nautobot_device_lifecycle_mgmt/models.py

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

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

ContactLCM

Bases: PrimaryModel

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

Source code in nautobot_device_lifecycle_mgmt/models.py

@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=CHARFIELD_MAX_LENGTH, null=True)
    address = models.CharField(max_length=CHARFIELD_MAX_LENGTH, blank=True)
    phone = models.CharField(max_length=CHARFIELD_MAX_LENGTH, blank=True)
    email = models.EmailField(blank=True, verbose_name="Contact E-mail")
    comments = models.TextField(blank=True, default="")
    priority = models.PositiveIntegerField(default=100)
    type = models.CharField(max_length=CHARFIELD_MAX_LENGTH, default=choices.PoCTypeChoices.UNASSIGNED)
    contract = models.ForeignKey(
        to="nautobot_device_lifecycle_mgmt.ContractLCM", on_delete=models.CASCADE, verbose_name="Contract", null=True
    )
    migrated_to_core_model_flag = models.BooleanField(
        default=False, help_text="Flag to indicate this instance was migrated to extras.Contact"
    )
    migrated_to_core_model = models.ForeignKey(to="extras.Contact", on_delete=models.SET_NULL, null=True, blank=True)

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

        verbose_name = "Contract POC"

        unique_together = ("contract", "name")

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

    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}"

Meta

Meta attributes for the class.

Source code in nautobot_device_lifecycle_mgmt/models.py

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

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

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}.")

ContractLCM

Bases: PrimaryModel

ContractLCM model for app.

Source code in nautobot_device_lifecycle_mgmt/models.py

@extras_features(
    "custom_fields",
    "custom_links",
    "custom_validators",
    "export_templates",
    "graphql",
    "relationships",
    "webhooks",
)
class ContractLCM(PrimaryModel):
    """ContractLCM model for app."""

    # 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=CHARFIELD_MAX_LENGTH, unique=True)
    number = models.CharField(max_length=CHARFIELD_MAX_LENGTH, blank=True, default="")
    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=CHARFIELD_MAX_LENGTH, blank=True, default=""
    )
    currency = models.CharField(verbose_name="Currency", max_length=4, blank=True, default="")
    contract_type = models.CharField(
        verbose_name="Contract Type", max_length=CHARFIELD_MAX_LENGTH, blank=True, default=""
    )
    devices = models.ManyToManyField(to="dcim.Device", related_name="device_contracts", blank=True)
    comments = models.TextField(blank=True, default="")

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

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

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

    @property
    def expired(self):
        """
        Return 'True' if a contract has expired, return 'False' if it is active.

        If a contract does not have an end date it cannot expire. If the
        current date is greater than the end date of a contract, it is
        expired. The last day of a contract is still considered to be
        in the 'active' period.
        """
        if not self.end:
            return False
        return datetime.today().date() > self.end

    @property
    def active(self):
        """
        Return 'True' if a contract is active, return 'False' if it has expired.

        An active contract is a contract that has not yet expired.
        If a contract does not have an end date it cannot expire. If the
        current date is less than or equal to the end date of a contract,
        it is active. The last day of a contract is still considered to be
        in the 'active' period.
        """
        if not self.end:
            return True
        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.")

    objects = ContractLCMQuerySet.as_manager()

active property

Return 'True' if a contract is active, return 'False' if it has expired.

An active contract is a contract that has not yet expired. If a contract does not have an end date it cannot expire. If the current date is less than or equal to the end date of a contract, it is active. The last day of a contract is still considered to be in the 'active' period.

expired property

Return 'True' if a contract has expired, return 'False' if it is active.

If a contract does not have an end date it cannot expire. If the current date is greater than the end date of a contract, it is expired. The last day of a contract is still considered to be in the 'active' period.

Meta

Meta attributes for the ContractLCM class.

Source code in nautobot_device_lifecycle_mgmt/models.py

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

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

clean()

Override clean to do custom validation.

Source code in nautobot_device_lifecycle_mgmt/models.py

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.")

save(*args, **kwargs)

Override save to assert a full clean.

Source code in nautobot_device_lifecycle_mgmt/models.py

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)

ContractLCMQuerySet

Bases: RestrictedQuerySet

Queryset for ContactLCM objects.

Source code in nautobot_device_lifecycle_mgmt/models.py

class ContractLCMQuerySet(RestrictedQuerySet):
    """Queryset for `ContactLCM` objects."""

    def get_for_object(self, obj):
        """Return all `ContractLCM` objets 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 = DeviceContractFilter(qs=self, item_obj=obj).filter_qs()  # pylint: disable=invalid-name
        elif isinstance(obj, InventoryItem):
            qs = InventoryItemContractFilter(qs=self, item_obj=obj).filter_qs()  # pylint: disable=invalid-name
        else:
            qs = self  # pylint: disable=invalid-name

        return qs

get_for_object(obj)

Return all ContractLCM objets assigned to the given object.

Source code in nautobot_device_lifecycle_mgmt/models.py

def get_for_object(self, obj):
    """Return all `ContractLCM` objets 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 = DeviceContractFilter(qs=self, item_obj=obj).filter_qs()  # pylint: disable=invalid-name
    elif isinstance(obj, InventoryItem):
        qs = InventoryItemContractFilter(qs=self, item_obj=obj).filter_qs()  # pylint: disable=invalid-name
    else:
        qs = self  # pylint: disable=invalid-name

    return qs

DeviceHardwareNoticeResult

Bases: PrimaryModel

Device hardware notice details model.

Source code in nautobot_device_lifecycle_mgmt/models.py

@extras_features(
    "graphql",
)
class DeviceHardwareNoticeResult(PrimaryModel):
    """Device hardware notice details model."""

    device = models.OneToOneField(
        to="dcim.Device",
        on_delete=models.CASCADE,
        help_text="The device",
        blank=False,
        related_name="device_hardware_notice",
    )
    hardware_notice = models.ForeignKey(
        to="nautobot_device_lifecycle_mgmt.HardwareLCM",
        on_delete=models.CASCADE,
        help_text="Device hardware notice",
        null=True,
        blank=True,
        related_name="hardware_notice_device",
    )
    is_supported = models.BooleanField(null=True, blank=True)
    last_run = models.DateTimeField(null=True, blank=True)
    run_type = models.CharField(max_length=CHARFIELD_MAX_LENGTH, choices=choices.ReportRunTypeChoices)

    class Meta:
        """Meta attributes for DeviceHardwareNoticeResult."""

        verbose_name = "Device Hardware Notice Report"
        ordering = ("device",)

    def __str__(self):
        """String representation of DeviceHardwareNoticeResult."""
        if self.is_supported:
            msg = f"Device: {self.device} - Supported"
        else:
            msg = f"Device: {self.device} - Not Supported"
        return msg

Meta

Meta attributes for DeviceHardwareNoticeResult.

Source code in nautobot_device_lifecycle_mgmt/models.py

class Meta:
    """Meta attributes for DeviceHardwareNoticeResult."""

    verbose_name = "Device Hardware Notice Report"
    ordering = ("device",)

__str__()

String representation of DeviceHardwareNoticeResult.

Source code in nautobot_device_lifecycle_mgmt/models.py

def __str__(self):
    """String representation of DeviceHardwareNoticeResult."""
    if self.is_supported:
        msg = f"Device: {self.device} - Supported"
    else:
        msg = f"Device: {self.device} - Not Supported"
    return msg

DeviceSoftwareValidationResult

Bases: PrimaryModel

Device Software validation details model.

Source code in nautobot_device_lifecycle_mgmt/models.py

@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="dcim.SoftwareVersion",
        on_delete=models.CASCADE,
        help_text="Device software",
        null=True,
        blank=True,
        related_name="+",
    )
    old_software = models.ForeignKey(
        to="SoftwareLCM",
        on_delete=models.SET_NULL,
        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=CHARFIELD_MAX_LENGTH, choices=choices.ReportRunTypeChoices)
    valid_software = models.ManyToManyField(
        to="ValidatedSoftwareLCM", related_name="device_software_validation_results"
    )

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

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

    def __str__(self):
        """String representation of DeviceSoftwareValidationResult."""
        if self.is_validated:
            msg = f"Device: {self.device} - Valid"
        else:
            msg = f"Device: {self.device} - Not Valid"
        return msg

Meta

Meta attributes for DeviceSoftwareValidationResult.

Source code in nautobot_device_lifecycle_mgmt/models.py

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

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

__str__()

String representation of DeviceSoftwareValidationResult.

Source code in nautobot_device_lifecycle_mgmt/models.py

def __str__(self):
    """String representation of DeviceSoftwareValidationResult."""
    if self.is_validated:
        msg = f"Device: {self.device} - Valid"
    else:
        msg = f"Device: {self.device} - Not Valid"
    return msg

HardwareLCM

Bases: PrimaryModel

HardwareLCM model for app.

Source code in nautobot_device_lifecycle_mgmt/models.py

@extras_features(
    "custom_fields",
    "custom_links",
    "custom_validators",
    "export_templates",
    "graphql",
    "relationships",
    "webhooks",
)
class HardwareLCM(PrimaryModel):
    """HardwareLCM model for app."""

    # 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(  # pylint: disable=nb-string-field-blank-null
        verbose_name="Inventory Item Part", max_length=CHARFIELD_MAX_LENGTH, 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(blank=True, default="", verbose_name="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

    @property
    def expired(self):
        """
        Return True if the current date is greater than the end of support date.

        If the end of support date has not been provided, return False.
        If the current date is less than or equal to the end of support date, return False.
        """
        today = datetime.today().date()
        if not getattr(self, "end_of_support"):
            return False
        return today > getattr(self, "end_of_support")

    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.",
                }
            )

expired property

Return True if the current date is greater than the end of support date.

If the end of support date has not been provided, return False. If the current date is less than or equal to the end of support date, return False.

Meta

Meta attributes for the HardwareLCM class.

Source code in nautobot_device_lifecycle_mgmt/models.py

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

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

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.",
            }
        )

save(*args, **kwargs)

Override save to assert a full clean.

Source code in nautobot_device_lifecycle_mgmt/models.py

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)

InventoryItemSoftwareValidationResult

Bases: PrimaryModel

InventoryItem Software validation details model.

Source code in nautobot_device_lifecycle_mgmt/models.py

@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="dcim.SoftwareVersion", on_delete=models.CASCADE, help_text="Inventory Item software", blank=True, null=True
    )
    old_software = models.ForeignKey(
        to="SoftwareLCM", on_delete=models.SET_NULL, 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=CHARFIELD_MAX_LENGTH, choices=choices.ReportRunTypeChoices)
    valid_software = models.ManyToManyField(
        to="ValidatedSoftwareLCM", related_name="inventory_item_software_validation_results"
    )

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

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

    def __str__(self):
        """String representation of InventoryItemSoftwareValidationResult."""
        if self.is_validated:
            msg = f"Inventory Item: {self.inventory_item.name} - " f"Device: {self.inventory_item.device.name} - Valid"
        else:
            msg = (
                f"Inventory Item: {self.inventory_item.name} - "
                f"Device: {self.inventory_item.device.name} - Not Valid"
            )
        return msg

Meta

Meta attributes for InventoryItemSoftwareValidationResult.

Source code in nautobot_device_lifecycle_mgmt/models.py

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

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

__str__()

String representation of InventoryItemSoftwareValidationResult.

Source code in nautobot_device_lifecycle_mgmt/models.py

def __str__(self):
    """String representation of InventoryItemSoftwareValidationResult."""
    if self.is_validated:
        msg = f"Inventory Item: {self.inventory_item.name} - " f"Device: {self.inventory_item.device.name} - Valid"
    else:
        msg = (
            f"Inventory Item: {self.inventory_item.name} - "
            f"Device: {self.inventory_item.device.name} - Not Valid"
        )
    return msg

ProviderLCM

Bases: OrganizationalModel

ProviderLCM model for app.

Source code in nautobot_device_lifecycle_mgmt/models.py

@extras_features(
    "custom_fields",
    "custom_links",
    "custom_validators",
    "export_templates",
    "graphql",
    "relationships",
    "webhooks",
)
class ProviderLCM(OrganizationalModel):
    """ProviderLCM model for app."""

    # Set model columns
    name = models.CharField(max_length=CHARFIELD_MAX_LENGTH, unique=True)
    description = models.CharField(max_length=CHARFIELD_MAX_LENGTH, blank=True)
    physical_address = models.CharField(max_length=CHARFIELD_MAX_LENGTH, blank=True)
    country = models.CharField(max_length=3, blank=True)
    phone = models.CharField(max_length=CHARFIELD_MAX_LENGTH, 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, default="")

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

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

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

    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)

Meta

Meta attributes for the class.

Source code in nautobot_device_lifecycle_mgmt/models.py

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

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

save(*args, **kwargs)

Override save to assert a full clean.

Source code in nautobot_device_lifecycle_mgmt/models.py

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)

SoftwareImageLCM

Bases: PrimaryModel

SoftwareImageLCM model.

Source code in nautobot_device_lifecycle_mgmt/models.py

@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=CHARFIELD_MAX_LENGTH, 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="software_images", 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")
    hashing_algorithm = models.CharField(
        default="", blank=True, max_length=CHARFIELD_MAX_LENGTH, verbose_name="Hashing Algorithm"
    )
    default_image = models.BooleanField(verbose_name="Default Image", default=False)
    migrated_to_core_model_flag = models.BooleanField(
        default=False, help_text="Flag to indicate this instance was migrated to dcim.SoftwareImageFile"
    )
    migrated_to_core_model = models.ForeignKey(
        to="dcim.SoftwareImageFile", on_delete=models.SET_NULL, null=True, blank=True
    )

    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

    objects = SoftwareImageLCMQuerySet.as_manager()

Meta

Meta attributes for SoftwareImageLCM.

Source code in nautobot_device_lifecycle_mgmt/models.py

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

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

SoftwareImageLCMQuerySet

Bases: RestrictedQuerySet

Queryset for SoftwareImageLCM objects.

Source code in nautobot_device_lifecycle_mgmt/models.py

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()  # pylint: disable=invalid-name
        elif isinstance(obj, InventoryItem):
            qs = InventoryItemSoftwareImageFilter(qs=self, item_obj=obj).filter_qs()  # pylint: disable=invalid-name
        else:
            qs = self  # pylint: disable=invalid-name

        return qs

get_for_object(obj)

Return all SoftwareImageLCM assigned to the given object.

Source code in nautobot_device_lifecycle_mgmt/models.py

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()  # pylint: disable=invalid-name
    elif isinstance(obj, InventoryItem):
        qs = InventoryItemSoftwareImageFilter(qs=self, item_obj=obj).filter_qs()  # pylint: disable=invalid-name
    else:
        qs = self  # pylint: disable=invalid-name

    return qs

SoftwareLCM

Bases: PrimaryModel

Software Life-Cycle Management model.

Source code in nautobot_device_lifecycle_mgmt/models.py

@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=CHARFIELD_MAX_LENGTH)
    alias = models.CharField(max_length=CHARFIELD_MAX_LENGTH, blank=True, default="")
    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)
    migrated_to_core_model_flag = models.BooleanField(
        default=False, help_text="Flag to indicate this instance was migrated to dcim.SoftwareVersion"
    )
    migrated_to_core_model = models.ForeignKey(
        to="dcim.SoftwareVersion", on_delete=models.SET_NULL, null=True, blank=True
    )

    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}"

    objects = SoftwareLCMQuerySet.as_manager()

Meta

Meta attributes for SoftwareLCM.

Source code in nautobot_device_lifecycle_mgmt/models.py

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

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

SoftwareLCMQuerySet

Bases: RestrictedQuerySet

Queryset for SoftwareLCM objects.

Source code in nautobot_device_lifecycle_mgmt/models.py

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()  # pylint: disable=invalid-name
        elif isinstance(obj, InventoryItem):
            qs = InventoryItemSoftwareFilter(qs=self, item_obj=obj).filter_qs()  # pylint: disable=invalid-name
        else:
            qs = self  # pylint: disable=invalid-name

        return qs

get_for_object(obj)

Return all SoftwareLCM assigned to the given object.

Source code in nautobot_device_lifecycle_mgmt/models.py

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()  # pylint: disable=invalid-name
    elif isinstance(obj, InventoryItem):
        qs = InventoryItemSoftwareFilter(qs=self, item_obj=obj).filter_qs()  # pylint: disable=invalid-name
    else:
        qs = self  # pylint: disable=invalid-name

    return qs

ValidatedSoftwareLCM

Bases: PrimaryModel

ValidatedSoftwareLCM model.

Source code in nautobot_device_lifecycle_mgmt/models.py

@extras_features(
    "custom_fields",
    "custom_links",
    "custom_validators",
    "export_templates",
    "relationships",
    "statuses",
    "webhooks",
)
class ValidatedSoftwareLCM(PrimaryModel):
    """ValidatedSoftwareLCM model."""

    software = models.ForeignKey(
        to="dcim.SoftwareVersion", on_delete=models.CASCADE, verbose_name="Software Version", null=True
    )
    old_software = models.ForeignKey(
        to="SoftwareLCM", on_delete=models.SET_NULL, verbose_name="Software Version", blank=True, null=True
    )
    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="extras.Role", 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)

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

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

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

    @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."
            )

    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

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

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

__str__()

String representation of ValidatedSoftwareLCM.

Source code in nautobot_device_lifecycle_mgmt/models.py

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

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."
        )

save(*args, **kwargs)

Override save to assert a full clean.

Source code in nautobot_device_lifecycle_mgmt/models.py

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)

ValidatedSoftwareLCMQuerySet

Bases: RestrictedQuerySet

Queryset for ValidatedSoftwareLCM objects.

Source code in nautobot_device_lifecycle_mgmt/models.py

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()  # pylint: disable=invalid-name
        elif isinstance(obj, InventoryItem):
            qs = InventoryItemValidatedSoftwareFilter(qs=self, item_obj=obj).filter_qs()  # pylint: disable=invalid-name
        elif isinstance(obj, DeviceType):
            qs = ValidatedSoftwareLCM.objects.filter(device_types=obj)  # pylint: disable=invalid-name
        else:
            qs = self  # pylint: disable=invalid-name

        return qs

get_for_object(obj)

Return all ValidatedSoftwareLCM assigned to the given object.

Source code in nautobot_device_lifecycle_mgmt/models.py

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()  # pylint: disable=invalid-name
    elif isinstance(obj, InventoryItem):
        qs = InventoryItemValidatedSoftwareFilter(qs=self, item_obj=obj).filter_qs()  # pylint: disable=invalid-name
    elif isinstance(obj, DeviceType):
        qs = ValidatedSoftwareLCM.objects.filter(device_types=obj)  # pylint: disable=invalid-name
    else:
        qs = self  # pylint: disable=invalid-name

    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

@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(to="dcim.SoftwareVersion", on_delete=models.CASCADE, blank=True, null=True)
    old_software = models.ForeignKey(SoftwareLCM, on_delete=models.SET_NULL, 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",
    )

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

        verbose_name = "Vulnerability"
        verbose_name_plural = "Vulnerabilities"
        unique_together = (
            ("cve", "software", "device"),
            ("cve", "software", "inventory_item"),
        )

    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

Meta

Meta attributes for the class.

Source code in nautobot_device_lifecycle_mgmt/models.py

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

    verbose_name = "Vulnerability"
    verbose_name_plural = "Vulnerabilities"
    unique_together = (
        ("cve", "software", "device"),
        ("cve", "software", "inventory_item"),
    )

__str__()

String representation of the model.

Source code in nautobot_device_lifecycle_mgmt/models.py

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