Edits history of script submission #23932 for ' List Sites (netbox)'

• python3

  Ap­pro­ved version

  Edit in Windmill

  Embed

  # py312
  # requirements:
  # pynetbox==7.9.0
  
  
  from typing import List, Literal, 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,
      status: Optional[
          List[Literal["planned", "staging", "active", "decommissioning", "retired"]]
      ] = None,
      tag: Optional[List[str]] = None,
      limit: Optional[int] = None,
      offset: Optional[int] = None,
  ):
      """
      List Sites
      List sites, optionally filtered by search text, status or tag.
      """
      records = api(auth).dcim.sites.filter(
          **keep(q=q, status=status, tag=tag),
          # 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