Edits history of script submission #23926 for ' List Device Types (netbox)'

  • python3
    One script reply has been approved by the moderators
    Ap­pro­ved
    # py312
    # requirements:
    # pynetbox==7.9.0
    
    
    from typing import Optional, TypedDict
    
    import pynetbox
    
    
    class netbox(TypedDict):
        url: str
        token: str
    
    
    def api(auth: netbox):
        # pynetbox adds /api itself; the resource URL may already end with it.
        return pynetbox.api(
            auth["url"].rstrip("/").removesuffix("/api"), token=auth["token"]
        )
    
    
    def keep(**fields):
        # The run form sends "" / [] / {} for untouched fields: drop them.
        return {k: v for k, v in fields.items() if v not in (None, "", [], {})}
    
    
    def page(records):
        # One page (limit/offset), as NetBox's count plus the raw records.
        results = [dict(r) for r in records]
        return {"count": len(records), "results": results}
    
    
    def main(
        auth: netbox,
        q: Optional[str] = None,
        manufacturer_id: Optional[int] = None,
        limit: Optional[int] = None,
        offset: Optional[int] = None,
    ):
        """
        List Device Types
        List device types (hardware models), optionally for one manufacturer.
        """
        records = api(auth).dcim.device_types.filter(
            **keep(q=q, manufacturer_id=manufacturer_id),
            # limit=0 means NetBox's MAX_PAGE_SIZE, which also caps an explicit 1000.
            limit=50 if limit is None else limit or 1000,
            offset=offset or 0,
        )
        return page(records)
    

    Submitted by hugo989 3 hours ago