Custom Script variable query by current username

[IsarNet-Joe]

Hi NetBox community,

I want to write a custom script and want to set the Owner attribute for a newly created object using the custom script.

The NetBox user should have an ObjectVar input variable, which only lists the Owner objects, where the user is member:

    vm_owner = ObjectVar(
        label="VM ownership",
        description="The owner of the VM",
        model=Owner,
        query_params={
            'user': request.user.username
        },
        required=True)

In the query_params, I want to filter by the currently logged in user user .

I know, that I can access the username using self.request.user.username in the class methods of a Script class.
Is there a way to access this data in the variable definitions?

[pheus]

Hi @IsarNet-Joe,

The user filter is available and accepts a username, so a static value such as query_params={'user': 'alice'} should work as expected.

The issue here is the point at which script variables are created. They are defined as class attributes when the script module is loaded. At that time, there is no active HTTP request or Script instance, so neither request.user nor self.request is available. NetBox assigns self.request only when the submitted script starts running, after the form has already been created, displayed, and validated.

query_params currently supports static values and references to other script fields using $field_name, but it cannot dynamically resolve the currently logged-in user. Therefore, filtering an ObjectVar based on the requesting user is not currently supported.

One other detail to keep in mind is that the user filter checks only users assigned directly to an Owner. It does not include users who belong to a group associated with that Owner.

As a workaround, you could perform the membership check inside the script’s run() method, where self.request.user is available. The script could then stop with a clear error message if the requesting user is not assigned to the selected Owner, either directly or through one of its groups.

This would not filter the available choices in the form, but it would ensure that the selected Owner is validated before the script makes any changes.

[IsarNet-Joe]

Thank you @pheus for the detailed answer. Will follow your advise and catch the exception inside the run() method.