Skip to content

Models

nautobot_chatops.models

Django models for recording user interactions with Nautobot.

AccessGrant

Bases: PrimaryModel

Record of a single form of access granted to the chatbot.

Source code in nautobot_chatops/models.py 
 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
class AccessGrant(PrimaryModel):
    """Record of a single form of access granted to the chatbot."""

    command = models.CharField(max_length=64, help_text=ACCESS_GRANT_COMMAND_HELP_TEXT)
    subcommand = models.CharField(
        max_length=64,
        help_text=ACCESS_GRANT_SUBCOMMAND_HELP_TEXT,
    )

    grant_type = models.CharField(max_length=32, choices=AccessGrantTypeChoices)

    name = models.CharField(max_length=255, help_text=ACCESS_GRANT_NAME_HELP_TEXT)
    value = models.CharField(
        max_length=255,
        help_text=ACCESS_GRANT_VALUE_HELP_TEXT,
    )

    def clean(self):
        """Model validation logic."""
        super().clean()
        if self.command == "*" and self.subcommand != "*":
            raise ValidationError("Use of a command wildcard with a non-wildcard subcommand is not permitted")

    def __str__(self):
        """String representation of an AccessGrant."""
        return f'cmd: "{self.command} {self.subcommand}", {self.grant_type}: "{self.name}" ({self.value})'

    def get_absolute_url(self, api=False):
        """Override the objects absolute url since we have no detail view."""
        return reverse("plugins:nautobot_chatops:accessgrant_list")

    class Meta:
        """Meta-attributes of an AccessGrant."""

        ordering = ["command", "subcommand", "grant_type"]
        unique_together = [["command", "subcommand", "grant_type", "value"]]

Meta

Meta-attributes of an AccessGrant.

Source code in nautobot_chatops/models.py 
125
126
127
128
129
class Meta:
    """Meta-attributes of an AccessGrant."""

    ordering = ["command", "subcommand", "grant_type"]
    unique_together = [["command", "subcommand", "grant_type", "value"]]

__str__()

String representation of an AccessGrant.

Source code in nautobot_chatops/models.py 
117
118
119
def __str__(self):
    """String representation of an AccessGrant."""
    return f'cmd: "{self.command} {self.subcommand}", {self.grant_type}: "{self.name}" ({self.value})'

clean()

Model validation logic.

Source code in nautobot_chatops/models.py 
111
112
113
114
115
def clean(self):
    """Model validation logic."""
    super().clean()
    if self.command == "*" and self.subcommand != "*":
        raise ValidationError("Use of a command wildcard with a non-wildcard subcommand is not permitted")

get_absolute_url(api=False)

Override the objects absolute url since we have no detail view.

Source code in nautobot_chatops/models.py 
121
122
123
def get_absolute_url(self, api=False):
    """Override the objects absolute url since we have no detail view."""
    return reverse("plugins:nautobot_chatops:accessgrant_list")

Bases: PrimaryModel

Connect ChatOps User with Nautobot User.

Source code in nautobot_chatops/models.py 
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
class ChatOpsAccountLink(PrimaryModel):
    """Connect ChatOps User with Nautobot User."""

    nautobot_user = models.ForeignKey(
        to=settings.AUTH_USER_MODEL,
        on_delete=models.CASCADE,
        related_name="chatops_user",
        verbose_name="User",
    )
    platform = models.CharField(max_length=32, choices=PlatformChoices)
    user_id = models.CharField(max_length=255, help_text=CHATOPS_USER_ID_HELP_TEXT, verbose_name="Chat User ID")
    email = models.EmailField(blank=True)

    def __str__(self):
        """String representation of a ChatOps Account Link."""
        return f"{self.nautobot_user.username} -> {self.platform} {self.user_id}"

    class Meta:
        """Metadata for ChatOps Account Link."""

        unique_together = [["user_id", "platform"]]
        verbose_name = "ChatOps Account Link"

Meta

Metadata for ChatOps Account Link.

Source code in nautobot_chatops/models.py 
171
172
173
174
175
class Meta:
    """Metadata for ChatOps Account Link."""

    unique_together = [["user_id", "platform"]]
    verbose_name = "ChatOps Account Link"

__str__()

String representation of a ChatOps Account Link.

Source code in nautobot_chatops/models.py 
167
168
169
def __str__(self):
    """String representation of a ChatOps Account Link."""
    return f"{self.nautobot_user.username} -> {self.platform} {self.user_id}"

CommandLog

Bases: PrimaryModel

Record of a single fully-executed Nautobot command.

Incomplete commands (those requiring additional user input) should not be recorded, nor should any "help" commands or invalid command entries.

Source code in nautobot_chatops/models.py 
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
class CommandLog(PrimaryModel):  # pylint: disable=nb-string-field-blank-null
    """Record of a single fully-executed Nautobot command.

    Incomplete commands (those requiring additional user input) should not be recorded,
    nor should any "help" commands or invalid command entries.
    """

    start_time = models.DateTimeField(null=True)
    runtime = models.DurationField(null=True)

    user_name = models.CharField(max_length=255, help_text=COMMAND_LOG_USER_NAME_HELP_TEXT)
    user_id = models.CharField(max_length=255, help_text=COMMAND_LOG_USER_ID_HELP_TEXT)
    platform = models.CharField(max_length=64, help_text=COMMAND_LOG_PLATFORM_HELP_TEXT)
    platform_color = ColorField()

    command = models.CharField(max_length=64, help_text=COMMAND_LOG_COMMAND_TEXT)
    subcommand = models.CharField(max_length=64, help_text=COMMAND_LOG_SUBCOMMAND_HELP_TEXT)

    params = models.JSONField(default=list, help_text=COMMAND_LOG_PARAMS_HELP_TEXT)

    status = models.CharField(
        max_length=32,
        choices=CommandStatusChoices,
        default=CommandStatusChoices.STATUS_SUCCEEDED,
    )
    details = models.CharField(max_length=255, default="")
    nautobot_user = models.ForeignKey(
        to=settings.AUTH_USER_MODEL,
        on_delete=models.SET_NULL,
        blank=True,
        null=True,
        related_name="command_log",
    )

    @property
    def status_label_class(self):
        """Bootstrap CSS label class for each status value."""
        # pylint: disable=no-else-return
        if self.status == CommandStatusChoices.STATUS_SUCCEEDED:
            return "success"
        elif self.status == CommandStatusChoices.STATUS_BLOCKED:
            return "default"
        elif self.status == CommandStatusChoices.STATUS_FAILED:
            return "warning"
        else:  # STATUS_ERRORED, STATUS_UNKNOWN
            return "danger"

    def __str__(self):
        """String representation of a CommandLog entry."""
        return f"{self.user_name} on {self.platform}: {self.command} {self.subcommand} {self.params} ({self.status})"

    def get_absolute_url(self, api=False):
        """Override the objects absolute url since we have no detail view."""
        return reverse("plugins:nautobot_chatops:commandlog_list")

    class Meta:
        """Meta-attributes of a CommandLog."""

        ordering = ["start_time"]

status_label_class property

Bootstrap CSS label class for each status value.

Meta

Meta-attributes of a CommandLog.

Source code in nautobot_chatops/models.py 
88
89
90
91
class Meta:
    """Meta-attributes of a CommandLog."""

    ordering = ["start_time"]

__str__()

String representation of a CommandLog entry.

Source code in nautobot_chatops/models.py 
80
81
82
def __str__(self):
    """String representation of a CommandLog entry."""
    return f"{self.user_name} on {self.platform}: {self.command} {self.subcommand} {self.params} ({self.status})"

get_absolute_url(api=False)

Override the objects absolute url since we have no detail view.

Source code in nautobot_chatops/models.py 
84
85
86
def get_absolute_url(self, api=False):
    """Override the objects absolute url since we have no detail view."""
    return reverse("plugins:nautobot_chatops:commandlog_list")

CommandToken

Bases: PrimaryModel

Record of a Token granted for the chat platform and chat command.

Source code in nautobot_chatops/models.py 
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
class CommandToken(PrimaryModel):
    """Record of a Token granted for the chat platform and chat command."""

    comment = models.CharField(max_length=255, help_text=COMMAND_TOKEN_COMMENT_HELP_TEXT, blank=True, default="")
    platform = models.CharField(max_length=32, choices=PlatformChoices)
    token = models.CharField(max_length=255, help_text=COMMAND_TOKEN_TOKEN_HELP_TEXT)

    def __str__(self):
        """String representation of a CommandToken."""
        return f'platform: "{self.platform}", token: "{self.token}", comment: "{self.comment}"'

    def get_absolute_url(self, api=False):
        """Override the objects absolute url since we have no detail view."""
        return reverse("plugins:nautobot_chatops:commandtoken_list")

    class Meta:
        """Meta-attributes of a CommandToken."""

        ordering = ["platform", "token", "comment"]
        unique_together = [["platform", "token"]]

Meta

Meta-attributes of a CommandToken.

Source code in nautobot_chatops/models.py 
147
148
149
150
151
class Meta:
    """Meta-attributes of a CommandToken."""

    ordering = ["platform", "token", "comment"]
    unique_together = [["platform", "token"]]

__str__()

String representation of a CommandToken.

Source code in nautobot_chatops/models.py 
139
140
141
def __str__(self):
    """String representation of a CommandToken."""
    return f'platform: "{self.platform}", token: "{self.token}", comment: "{self.comment}"'

get_absolute_url(api=False)

Override the objects absolute url since we have no detail view.

Source code in nautobot_chatops/models.py 
143
144
145
def get_absolute_url(self, api=False):
    """Override the objects absolute url since we have no detail view."""
    return reverse("plugins:nautobot_chatops:commandtoken_list")